Gittes-archive/new-horizons
2
0
Fork 0
mirror of https://github.com/Outer-Wilds-New-Horizons/new-horizons.git synced 2025-12-11 20:15:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #204 from xen-42/docs/update-setup

Browse Source 
Update Setup.md
This commit is contained in:
Ben C 2022-06-19 21:20:58 -04:00 committed by GitHub
commit c08fcba9eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Setup.md
View File

@ -22,11 +22,9 @@ pipenv install --dev
## Environment Variables ## Environment Variables
- URL_PREFIX: Path to put before all links and static files, see below for recommended values - URL_PREFIX: Path to put before all links and static files, see below for recommended values
- Production: "/" - Production and Local Builds: "/"
- Local Build: "" (set as empty string)
- PyCharm Development Server: "/outer-wilds-new-horizons/docs/out/" - PyCharm Development Server: "/outer-wilds-new-horizons/docs/out/"
## Copy Schemas ## Copy Schemas
Create a folder called `schemas` in the `docs/content/pages/` folder and copy all schemas to generate into it, make sure not to add this folder to git. Create a folder called `schemas` in the `docs/content/pages/` folder and copy all schemas to generate into it, make sure not to add this folder to git.
Production build automatically copies over schemas. Production build automatically copies over schemas.
@ -39,5 +37,5 @@ pipenv run menagerie generate
## Opening ## Opening
- Production: Go to the site - Production: Go to the site
- Local: Open `out/index.html` - Local: Go into `docs/out` in a new terminal window and run `py -m http.server 8080` and then connect to http://localhost:8080/
- PyCharm Development Server: Right click `out/index.html` -> Open In -> Browser -> Default - PyCharm Development Server: Right click `out/index.html` -> Open In -> Browser -> Default