vegvisir/website
1
0
Fork 0
mirror of https://codeberg.org/vegvisir/website.git synced 2025-09-14 00:43:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: update README with new install instructions (#3)

Browse source 
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 <victor@vlw.se>
Co-committed-by: vlw <victor@vlw.se>
This commit is contained in:
Victor Westerlund 2025-03-05 11:14:48 +00:00 • committed by Victor Westerlund
parent 6336281dd7
commit 1c9ec03b5e
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -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!
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
```