SwitchHacking/switch-guide
1
0
Fork 0
mirror of https://github.com/nh-server/switch-guide synced 2025-10-05 23:22:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Updated build instructions to reflect the VitePress overhaul.
This commit is contained in:
HunterMario
2025-03-13 21:07:59 -05:00
committed by GitHub
parent 96b5f65846
commit 67fcf4f559
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -4,9 +4,24 @@
Nintendo Switch homebrew guide written by staff members of the Nintendo Homebrew Discord server.
## Development
You will need Python 3 installed as well as pip3. The [mkdocs website](https://www.mkdocs.org) will explain how to do this, and how to install mkdocs. This guide was developed on Python 3.6 and 3.7.
## Running the site locally
After cloning the repository, you can install all the needed dependancies (including mkdocs) with this command, ran in the project's directory: `pip3 install --user -r requirements.txt`
This requires the following installed on your system:
Please take some time to familiarize yourself with mkdocs. [The site will detail everything for you.](https://www.mkdocs.org/#getting-started)
* [node.js](https://nodejs.org/en)
To test the website locally, clone the source code:
```bash
git clone https://github.com/nh-server/switch-guide.git --recurse-submodules
cd switch-guide
```
Then simply run the following commands:
```bash
npm ci
npm run docs:dev
```
The website should now be running on http://127.0.0.1:5173/ (or a port shown on the terminal). Any edits you make should appear live!