Skip to content

Commit 67fcf4f

Browse files
authored
Update README.md
Updated build instructions to reflect the VitePress overhaul.
1 parent 96b5f65 commit 67fcf4f

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,24 @@
44

55
Nintendo Switch homebrew guide written by staff members of the Nintendo Homebrew Discord server.
66

7-
## Development
8-
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.
7+
## Running the site locally
98

10-
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`
9+
This requires the following installed on your system:
1110

12-
Please take some time to familiarize yourself with mkdocs. [The site will detail everything for you.](https://www.mkdocs.org/#getting-started)
11+
* [node.js](https://nodejs.org/en)
12+
13+
To test the website locally, clone the source code:
14+
15+
```bash
16+
git clone https://github.com/nh-server/switch-guide.git --recurse-submodules
17+
cd switch-guide
18+
```
19+
20+
Then simply run the following commands:
21+
22+
```bash
23+
npm ci
24+
npm run docs:dev
25+
```
26+
27+
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!

0 commit comments

Comments
 (0)