Commit 6eb13d95 authored by Paul's avatar Paul
Browse files

Update README

parent 4f398683
...@@ -7,6 +7,7 @@ AMD's library for graph optimizations. ...@@ -7,6 +7,7 @@ AMD's library for graph optimizations.
* [MIOpen](https://github.com/ROCmSoftwarePlatform/MIOpen) for running on the GPU * [MIOpen](https://github.com/ROCmSoftwarePlatform/MIOpen) for running on the GPU
* [HIP](https://github.com/ROCm-Developer-Tools/HIP) for running on the GPU * [HIP](https://github.com/ROCm-Developer-Tools/HIP) for running on the GPU
* [Protobuf](https://github.com/google/protobuf) for reading [onxx](https://github.com/onnx/onnx) files * [Protobuf](https://github.com/google/protobuf) for reading [onxx](https://github.com/onnx/onnx) files
* [Half](http://half.sourceforge.net/) - IEEE 754-based half-precision floating point library
## Installing the dependencies ## Installing the dependencies
...@@ -70,6 +71,16 @@ The tests can be run by using the 'check' target: ...@@ -70,6 +71,16 @@ The tests can be run by using the 'check' target:
` cmake --build . --config Release --target check ` **OR** ` make check ` ` cmake --build . --config Release --target check ` **OR** ` make check `
This will build a local searchable web site inside the doc/html folder.
Documentation is built using [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html), [Sphinx](http://www.sphinx-doc.org/en/stable/index.html), and [Breathe](https://breathe.readthedocs.io/en/latest/)
Requirements for both Sphinx and Breathe can be installed with:
`pip install -r doc/requirements.txt`
Depending on your setup `sudo` may be required for the pip install.
## Building the documentation ## Building the documentation
HTML and PDF documentation can be built using: HTML and PDF documentation can be built using:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment