https://github.com/dfranx/shadered-docs
SHADERed official documentation
https://github.com/dfranx/shadered-docs
Last synced: over 1 year ago
JSON representation
SHADERed official documentation
- Host: GitHub
- URL: https://github.com/dfranx/shadered-docs
- Owner: dfranx
- License: cc-by-4.0
- Created: 2020-02-22T22:07:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-03T18:46:41.000Z (about 5 years ago)
- Last Synced: 2025-01-21T08:44:49.274Z (over 1 year ago)
- Language: HTML
- Homepage: http://docs.shadered.org
- Size: 9.49 MB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# SHADERed documentation
This repository contains files for SHADERed's [documentation](docs.shadered.org). It's written in reStructuredText and uses sphinx and `sphinx_rtd_theme`.
## Dependencies
On Ubuntu:
```bash
sudo apt install python3-sphinx
pip install sphinx-rtd-theme
```
For other platforms see: [https://www.sphinx-doc.org/en/master/usage/installation.html]
## Building
To build the html files run:
```bash
make html
```
## LICENSE
This documentation is licensed under Creative Commons Attribution 4.0 International license. See [LICENSE](./LICENSE) for more details.