From ef556bdb67000a6b371d97b1e0ac2462e051c782 Mon Sep 17 00:00:00 2001 From: emiyl Date: Wed, 2 Oct 2024 23:17:37 +0100 Subject: [PATCH] update readme installation instructions for new vitepress --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index bcdf76d6..0890c32f 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ # vita.hacks.guide -The complete guide to modding your PlayStation Vita. +A complete guide to PS Vita (TV) custom firmware, from stock to Ensō. https://vita.hacks.guide ## Running the site locally -This requires the following installed to your system: -- node.js, v14 or later -- its respective npm +This requires the following installed on your system: +- node.js -To test the website locally, simply run the following commands: -``` -npm install -``` -to install all packages required by the website (VuePress v2 and plugins), then +To test the website locally, clone the source code: + +```sh +git clone https://github.com/hacks-guide/Guide_Vita --recurse-submodules +cd Guide_Vita ``` + +Then simply run the following commands: + +```sh +npm ci npm run docs:dev ``` -to build the Markdown files into HTML and start a testing webserver on http://127.0.0.1:8080. + +The website should now be running on http://127.0.0.1:5173/ (or a port shown on the terminal). \ No newline at end of file