zcy
/
phyLS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update installation.rst

pull/1/head
潘鸿洋 2022-12-21 18:05:19 +08:00 committed by GitHub
parent e444b75ab8
commit ae9809adaf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/installation.rst
View File

@ -1,28 +1,17 @@
Installation Installation
============ ============
Percy is a header-only library. As such, no build steps are required to start If you want to run `phyLS`, you'll need to build some binaries. A modern compiler is required to build the libraries. The build instructions depend on your operating system. We are now only support Unix-like operating systems, compiled only successfully with Clang 6.0.1, Clang 12.0.0, GCC 7.3.0, and GCC 8.2.0.
using it. Simply add ${PERCY_ROOT}/include to your compiler's include path and
you're good to go. However, if you want to run the tests, you'll need to build
some binaries.
The build instructions depend on your operating system. On Unix-like operating Once those requirements are met, run the following commands to build and run the `phyLS`:
systems you will need either g++ (at least version 4.9.0) or clang++ (at least
version 3.5.0). On Windows you can build using Visual Studio. (NOTE: This has
been tested only with Visual Studio 2017.) Once those requirements are met, run
the following commands to build and run the tests:
.. code-block:: bash .. code-block:: bash
git clone --recurse-submodules https://github.com/whaaswijk/percy.git git clone --recursive https://github.com/panhongyang0/phyLS.git
cd percy cd phyLS
mkdir build mkdir build
cd build cd build
cmake .. -DPERCY_TEST=ON # Only on Unix cmake ..
cmake -DPERCY_TEST=ON -G "Visual Studio 15 2017" .. # On Windows make
make # Only on Unix ./bin/phyLS
make test # Only on Unix
On Unix systems this will build and run the test suite. On Windows it will
generate a solution file which allows you to build and run the tests using
Visual Studio.