annie/lavender.software
1
0
Fork 0
forked from lavender-legacy/lavender.software
Code Issues Pull requests Projects Releases Wiki Activity

Add setup instructions to the README

Browse source
This commit is contained in:
Charlotte Som 2022-03-05 14:38:32 +00:00
parent 79a9d27e42
commit 1e235dd0d1
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -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