Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nlogozzo authored Jan 3, 2024
1 parent 25ba5f0 commit c1f3926
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ Documentation for this library and its modules can be found [here](/docs).
## Installation with Conan

1. Download the `conanrecipe.py` file from the `conan` folder in the root directory of the repo.
1. Move `conanrecipe.py` to your project's directory.
1. Run `conan install conanrecipe.py --build=missing` to add libaura to your project with conan.
1. Rename `conanrecipe.py` to `conanfile.py` and move it to a new folder called `libaura`.
1. From this new `libaura` folder, run `conan create . --build=missing`.
1. Once this is completed, you can reference `libaura/2024.1.0` in your project's conanfile.

## Manual Building and Installation
libaura uses Conan package manager for resolving dependencies and CMake as it's build system.
Expand Down Expand Up @@ -52,4 +53,4 @@ Visual Studio 2022 with C++ Desktop workload is required to be installed.
1. To install libaura to the system, from the `build` folder, run `cmake --install . --prefix "PATH_TO_INSTALL_DIR"`.
- Replace `PATH_TO_INSTALL_DIR` with the path to a folder to install libaura to. This is usually a dependencies folder set up by the programmer, added to the PATH variable, to allow linking to said dependencies.
- On linux, `PATH_TO_INSTALL_DIR` would usually be `/usr`.
1. If contributing to upstream, remove `conanfile-windows.txt` and `conanprofile-windows.txt` from the repo's root directory as to not accidentally add and commit them.
1. If contributing to upstream, remove `conanfile-windows.txt` and `conanprofile-windows.txt` from the repo's root directory as to not accidentally add and commit them.

0 comments on commit c1f3926

Please sign in to comment.