Add Installation Guide for nmos-cpp Using Conan #386
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added Linux equivalents - Fixed typos Co-authored-by: Gareth Sylvester-Bradley <31761158+garethsb@users.noreply.github.com>
- direct deploy Linux equivalent commands added - Fixed formatting of %USERNAME%
Documentation to Install nmos-cpp with Conan 2
|
Hi @johanjino - this looks good to me - well done :) I'll put any specific comments in line with the documents. |
Comment on lines
+13
to
+17
| If the python Scripts directory is not on the PATH you will get a warning like: | ||
| > WARNING: The script conan.exe is installed in 'C:\Users\\%USERNAME%\\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\Scripts' which is not on PATH. | ||
| > Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location. | ||
|
|
||
| On Windows, you can use _System Properties \> Environment Variables..._ to permanently add the directory to the user PATH. Restart the Command Prompt and run `conan --help` to ensure Conan is found. |
There was a problem hiding this comment.
I think this all refers to Windows only so perhaps prefix the whole section with "On Windows, ..."?
Suggested change
| If the python Scripts directory is not on the PATH you will get a warning like: | |
| > WARNING: The script conan.exe is installed in 'C:\Users\\%USERNAME%\\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\Scripts' which is not on PATH. | |
| > Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location. | |
| On Windows, you can use _System Properties \> Environment Variables..._ to permanently add the directory to the user PATH. Restart the Command Prompt and run `conan --help` to ensure Conan is found. | |
| On Windows, if the python Scripts directory is not on the PATH you will get a warning like: | |
| > WARNING: The script conan.exe is installed in 'C:\Users\\%USERNAME%\\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\Scripts' which is not on PATH. | |
| > Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location. | |
| Also on Windows, you can use _System Properties \> Environment Variables..._ to permanently add the directory to the user PATH. Restart the Command Prompt and run `conan --help` to ensure Conan is found. |
There was a problem hiding this comment.
That specific example message is from Windows, but the warning can also occur on Linux.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation to install nmos-cpp using Conan package manager. The guide includes instructions for installing Conan, detecting profiles, installing nmos-cpp, and running the applications on both Windows and Linux platforms.