From 1e235dd0d1258aa76e147ef1326bc6e92b8f98e9 Mon Sep 17 00:00:00 2001 From: videogame hacker Date: Sat, 5 Mar 2022 14:38:32 +0000 Subject: [PATCH] Add setup instructions to the README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index c2d42b4..a36d88c 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,23 @@ Static site generated using [siru](https://github.com/videogame-hacker/siru) and hosted at [lavender.software](https://lavender.software/). +## Setting Up + +```shell +$ git clone 'git@lavender.software:lavender/lavender.software.git' +$ cd lavender.software/ +lavender.software/ $ mkdir dist # or follow instructions in 'Deploying' +lavender.software/ $ cargo run +... +lavender.software/ $ # Built files are in dist/ +``` + +You may want to `cd dist && python -m http.server` to get a local HTTP server. + ## Deploying +**Note:** You don't need to do this unless you're th eone deploying the site to the production environment. + ```shell $ # To set up, ensure that the 'dist' folder reflects the VPS $ git clone 'root@lavender.software:/srv/http/lavender.software' dist