From 1c9ec03b5ea546db0cc3dd549db25224dac6cd93 Mon Sep 17 00:00:00 2001 From: vlw Date: Wed, 5 Mar 2025 11:14:48 +0000 Subject: [PATCH] doc: update README with new install instructions (#3) Thanks to the new Vegvisir [install script](https://codeberg.org/vegvisir/install), getting started with Vegvisir projects [should be] easier than before. Reviewed-on: https://codeberg.org/vegvisir/website/pulls/3 Co-authored-by: vlw Co-committed-by: vlw --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ef44260..a72fd33 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ # Vegvisir Website -Source code for the [Vegvisir website](https://vegvisir.vlw.se). The website is build from the ground up using the [Vegvisir](https://codeberg.org/vegvisir/vegvisir) web framework to highlight the framework's features. +Source code for the [Vegvisir website](https://vegvisir.vlw.se). The website is build from the ground up using the [Vegvisir](https://codeberg.org/vegvisir/vegvisir) web framework to provide documentation and highlight the framework's features. # Installation -To run this website locally, follow the [installation instructions for the Vegvisir framework](https://vegvisir.vlw.se/docs/installation). After that, all you have to do is clone this repo and point Vegvisir to the cloned folder. +1. Clone this repo +```sh +git clone https://codeberg.org/vegvisir/website +``` -No additional steps are required! \ No newline at end of file +2. Run the [Vegvisir install script](https://codeberg.org/vegvisir/install) from the root directory of the repo +```sh +cd /path/to/website +``` +```sh +curl -fsSL https://href.vlw.se/vegvisir/install | bash +``` \ No newline at end of file