godotengine/doc-status
1
0
Fork 0
mirror of https://github.com/godotengine/doc-status.git synced 2025-12-31 13:48:23 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add setup instructions for local development

Browse Source
This commit is contained in:
Hugo Locurcio
2020-06-15 21:47:09 +02:00
parent a88e9d3198
commit c750d90ead
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -4,6 +4,20 @@ View the completion status of the Godot class reference (updated daily).
## [View](https://godotengine.github.io/doc-status/)
## Development
Follow these instructions to set up this site locally for development purposes:
- [Install Hugo](https://gohugo.io/getting-started/installing/) for your
operating system.
- Run the `build.sh` script to clone the Godot repository, generate a Markdown
file and build the website.
- On Windows 10, you should be able to run this script using the WSL.
- Run `hugo server` while working on the website CSS/JavaScript. The local
server will reload automatically on file changes.
- If you need to regenerate `content/_index.md`, run `build.sh` again. You can
do this while having the development server running.
## License
- Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.