diff --git a/README.md b/README.md index 8f46168..9d706fb 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ # 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 -First install trunk: + +First, install `trunk`: + ```bash 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 trunk serve ``` -in the projects root directory +