Updated the README to sound a little nicer.
This commit is contained in:
parent
9fa9c651ac
commit
33419e75f8
16
README.md
16
README.md
|
@ -1,15 +1,21 @@
|
||||||
# Frontend
|
# Frontend
|
||||||
This is the frontend of nerdcults main website.
|
|
||||||
|
As the mainpage of Nerdcult, the code contained in this repository includes
|
||||||
|
the Rust-written frontend script source as well as the HTML markup code and
|
||||||
|
the CSS styling.
|
||||||
|
|
||||||
## Running locally
|
## Running locally
|
||||||
First install trunk:
|
|
||||||
|
First, install `trunk`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cargo install trunk
|
cargo install trunk
|
||||||
```
|
```
|
||||||
Make sure, that `$HOME/.cargo/bin` is part of your `PATH`.
|
Make sure that `$HOME/.cargo/bin` is included in your `PATH`.
|
||||||
|
|
||||||
|
Following that, execute the following in the project's root directory:
|
||||||
|
|
||||||
Then run:
|
|
||||||
```bash
|
```bash
|
||||||
trunk serve
|
trunk serve
|
||||||
```
|
```
|
||||||
in the projects root directory
|
|
||||||
|
|
Loading…
Reference in New Issue