From 33419e75f829b44a067fc4c4adef639bbb7c6f7d Mon Sep 17 00:00:00 2001 From: Eric-Paul Ickhorn Date: Mon, 9 Oct 2023 10:18:56 +0200 Subject: [PATCH] Updated the README to sound a little nicer. --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) 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 +