Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[doc] Added make install to the macOS compiling instructions #1259

Merged
merged 3 commits into from
Aug 26, 2022
Merged

[doc] Added make install to the macOS compiling instructions #1259

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8956051
add `make install` to the MacOS building instructions
jdbruijn Jul 14, 2022
9f05210
add optional installation folder for macOS to compiling documentation
jdbruijn Jul 14, 2022
87b2121
remove note block from compiling docs note
jdbruijn Jul 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 6 additions & 3 deletions doc/compiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,12 @@ or execute (Debian-based systems only): `apt-get install gcc build-essential cma
1. Change into the project source directory: `cd stlink`
2. Run `make clean` -- required by some linux variants.
3. Run `make release` to create the _Release_ target
4. Run `make install` to full install the package with complete system integration
4. Run `make install` to full install the package with complete system integration. This might require sudo permissions.
5. Run `make debug` to create the _Debug_ target (_optional_)<br />
The debug target is only necessary in order to modify the sources and to run under a debugger.
6. Run `make package`to build a Debian Package. The generated packages can be found in the subdirectory `./build/dist`.

As an option you may also install to an individual user-defined folder e.g `$HOME` with `make install DESTDIR=$HOME`.
> **Note** As an option you may also install to an individual user-defined folder e.g `$HOME` with `make install DESTDIR=$HOME`.
jdbruijn marked this conversation as resolved.
Show resolved Hide resolved

#### Removal:

Expand Down Expand Up @@ -215,9 +215,12 @@ To do this with only one simple command, type:
1. Change into the project source directory: `cd stlink`
2. Run `make clean` to clean remnants of any previous builds.
3. Run `make release` to create the _Release_ target
4. Run `make debug` to create the _Debug_ target (_optional_)<br />
4. Run `make install` to full install the package with complete system integration. This might require sudo permissions.
jdbruijn marked this conversation as resolved.
Show resolved Hide resolved
5. Run `make debug` to create the _Debug_ target (_optional_)<br />
The debug target is only necessary in order to modify the sources and to run under a debugger.

Nightwalker-87 marked this conversation as resolved.
Show resolved Hide resolved
> **Note** As an option you may also install to an individual user-defined folder e.g `$HOME` with `make install DESTDIR=$HOME`.
jdbruijn marked this conversation as resolved.
Show resolved Hide resolved

## Build options

### Build using a different directory for shared libs
Expand Down