Merge pull request #87 from TheOnlyZac/update-docs

Update documentation website
TheOnlyZac · Jul 9, 2024 · 00e9ffe · 00e9ffe
2 parents 0c93fc7 + fede001
commit 00e9ffe
Show file tree

Hide file tree

Showing 4,227 changed files with 341,450 additions and 110,591 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 .vscode
+sly1
diff --git a/Doxyfile b/Doxyfile
diff --git a/README.md b/README.md
@@ -1,17 +1,26 @@
 # Sly Cooper Decompilation Docs
 
-This branch contains the documentation for the Sly Cooper Decompilation Project. The docs are generated automatically from the codebase using [Doxygen](https://www.doxygen.nl/index.html). It is hosted on GitHub Pages at [theonlyzac.github.io/sly1](https://theonlyzac.github.io/sly1/).
+This branch contains the documentation for the Sly Cooper decompilation. The docs are generated automatically from the codebase using [Doxygen](https://www.doxygen.nl/index.html). It is hosted on GitHub Pages at [theonlyzac.github.io/sly1](https://theonlyzac.github.io/sly1/).
 
 
-## Generating Docs
+## Generating docs
 
-**Requirements**: doxygen, graphviz
+Clone the repo and install dependencies.
 
-Clone the repo and run the `generate.sh` script. This will generate the documentation in the `html` directory. You can open `html/index.html` in your browser to preview the documentation.
+```bash
+sudo apt-get install doxygen graphviz
+```
+
+Then run `generate.sh`. It will generate the documentation in the `html` directory. You can open `html/index.html` directly in your browser, or host it using node.js/express as follows.
+
+```bash
+npm install
+npm start
+```
 
 
 ## Contributing
 
-If you find any errors in the documentation, please [open an issue](https://github.com/theonlyzac/sly1/issues/new) or make a pull request on the [main branch](https://github.com/theonlyzac/sly1) to address it directly.
+If you find any errors in the documentation, please [open an issue](https://github.com/theonlyzac/sly1/issues/new) or make a pull request.
 
 If you are making a pull request to update the documentation files on this branch, don't forget to `git add` the `html` directory before pushing.
diff --git a/docs/CMakeLists_8txt.html b/docs/CMakeLists_8txt.html
diff --git a/docs/actseg_8h.html b/docs/actseg_8h.html
diff --git a/docs/actseg_8h__incl.map b/docs/actseg_8h__incl.map
diff --git a/docs/actseg_8h__incl.md5 b/docs/actseg_8h__incl.md5
diff --git a/docs/actseg_8h__incl.png b/docs/actseg_8h__incl.png