phynexis-deps/ensmallen
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

automatic installation before manual installation

Browse Source 
* place automatic installation instructions before manual installation instructions
* adapt text to improve flow
* fix bug in path for cmake non-root installation
This commit is contained in:
Conrad Sanderson
2021-06-23 16:35:30 +02:00
committed by GitHub
parent 3c1bad105c
commit bb18d79413
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -10
View File
@@ -22,17 +22,14 @@ gradient-free optimizers, and constrained optimization.
### Installation
ensmallen can be installed in several ways.
ensmallen can be installed in several ways: automatically or manually, with or without root access.
A straightforward approach is to simply copy the `include/ensmallen.hpp` header ***and*** the associated `include/ensmallen_bits` directory to a location such as `/usr/include/` which is searched by your C++ compiler.
If you can't use `sudo` or don't have write access to `/usr/include/`, use a directory within your own home directory (eg. `/home/blah/include/`).
Installation can also be done with CMake 3.3+, which will also build the tests.
Automatic installation is done with CMake 3.3+, which will check the requirements and also build the tests.
If CMake is not already available on your system, it can be obtained from [cmake.org](https://cmake.org).
If you are using an older system such as RHEL 7 or CentOS 7,
an updated version of CMake is also available via the EPEL repository via the `cmake3` package.
an updated version of CMake is also available via the EPEL repository (see the `cmake3` package).
Example cmake based installation with root access:
Example automatic installation with root access:
```
mkdir build
@@ -41,16 +38,20 @@ cmake ..
sudo make install
```
Example cmake based installation without root access:
Example automatic installation without root access, installing into `/home/blah/` (adapt as required):
```
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/home/blah/include/
cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/home/blah/
make install
```
Change `/home/blah/include/` as required.
The above will create a directory named `/home/blah/include/` and place all ensmallen headers there.
Manual installation involves simply copying the `include/ensmallen.hpp` header ***and*** the associated `include/ensmallen_bits` directory to a location such as `/usr/include/` which is searched by your C++ compiler.
If you can't use `sudo` or don't have write access to `/usr/include/`, use a directory within your own home directory (eg. `/home/blah/include/`).
### Example Compilation