From c1f392690095b3691d70762614486a6ee50caa30 Mon Sep 17 00:00:00 2001 From: Nick Logozzo Date: Wed, 3 Jan 2024 12:32:49 -0500 Subject: [PATCH] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ba8550c..43acb4c 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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. \ No newline at end of file +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.