DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-13 05:48:35 +00:00
Code Issues Releases Wiki Activity

Create readme.md

Browse Source
This commit is contained in:
Robert Beekman 2020-11-02 20:17:22 +01:00 committed by GitHub
parent ca3dd4fb73
commit d59b36c3d1
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docfx/readme.md Normal file
View File

@ -0,0 +1,10 @@
To generate the [Artemis API docs](https://artemis-rgb.com/docs/) we use [DocFX](https://dotnet.github.io/docfx/).
To build locally run the following commands from this folder.
#### Want to build? Follow these instructions (Windows)
1. Ensure you can build the Artemis solution as per the [main build instructions](https://github.com/Artemis-RGB/Artemis#want-to-build-follow-these-instructions)
2. Install DocFX (with Chocolatey: `choco install docfx`)
3. Open PowerShell in `<repo>\docfx` (the same folder as this readme file)
4. Run `docfx .\docfx_project\docfx.json` to build static files
Run `docfx .\docfx_project\docfx.json --serve` to serve locally