riki/treehouse
riki/treehouse
1
Fork 0
Code Issues 14 Activity

update readme

Browse source
This commit is contained in:
りき萌 2024-02-07 11:25:10 +01:00
parent e974dd9839
commit 1178e51d5d
1 changed files with 5 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -14,24 +14,22 @@ You have been warned.
## Building
To build the website:
To serve the website on `http://localhost:8080`:
```sh
cargo run -p treehouse generate
cargo run -p treehouse serve
```
This will spit out a directory `target/site` containing the static pages. You're free to use any HTTP server you wish, but for development purposes treehouse includes one in the CLI:
This will start a server on port 8080. You can change the port by using `--port`, but note that you'll also have to override the website address. The treehouse hardcodes all URLs to point to its own address and therefore needs a base URL, provided with `$TREEHOUSE_SITE` or more permanently by setting `site` inside `treehouse.toml`:
```sh
cargo run -p treehouse generate --serve 8080
TREEHOUSE_SITE="http://localhost:8081" cargo run -p treehouse serve --port 8081
```
This will fire up a server on port 8080.
If you're developing, you may wanna use [`cargo-watch`](https://crates.io/crates/cargo-watch):
```sh
cargo watch -- cargo run -p treehouse generate --serve
cargo watch -- cargo run -p treehouse serve
```
The website will reload itself automatically if you change any file in the repository.