Skip to content

Commit

Permalink
Add ST-Link driver note & License
Browse files Browse the repository at this point in the history
  • Loading branch information
daguirrem committed May 16, 2024
1 parent bd3b6e7 commit bd6a177
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 David A. Aguirre M <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DSP Board SDK

This repository have all necesary files, folders and scripts to build DSP Board SDK **installer** to Windows and Linux (Debian based) machines.
This repository have all necesary files, folders and scripts to build DSP Board SDK **Installer** to Windows and Linux (Debian based) machines.

If you want **only install** the DSP Board SDK, please download the lastest version from [Releases](https://github.com/daguirrem/DSPBoard-SDK/releases) and follow the [*How to install?*](#how-to-install) section.

Expand Down Expand Up @@ -51,6 +51,9 @@ git lfs checkout
- Xpack windows build tools 4.4-2

4. Open build.iss file (With Inno setup) and compile the installer (CTRL+F9). This generates a installer called dsp_board_sdk_win_x64.exe at root of repository folder.
```pwsh
& .\build.iss
```

## Linux
1. Give execution permisions to builder scripts.
Expand Down Expand Up @@ -102,6 +105,7 @@ git lfs checkout

Just run the builded/downloaded installer (dsp_board_sdk_win_x64.exe) and follow the steps.

(Optional): Download and install the lastest driver for st-link debugger from [STMicroelectronics web](https://www.st.com/en/development-tools/stsw-link009.html).
## Linux

If you builded your DSPBoard SDK Installer from scratch just run at terminal:
Expand All @@ -116,3 +120,6 @@ Else if you dowloaded the installer from *Releases*, give execution permissions
chmod +x ./dsp_board_sdk_linux_x64.run
./dsp_board_sdk_linux_x64.run
```

# License
_DSPBoard SDK_ is licensed by MIT License, more information on [LICENSE.md](LICENSE.md)

0 comments on commit bd6a177

Please sign in to comment.