mirror of
https://codeberg.org/vegvisir/website.git
synced 2025-09-14 08:53:42 +02:00
doc(chore): update README with new install instructions
This commit is contained in:
parent
6336281dd7
commit
ee19b76c48
1 changed files with 12 additions and 3 deletions
15
README.md
15
README.md
|
@ -1,9 +1,18 @@
|
||||||
# Vegvisir Website
|
# 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
|
# 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
|
||||||
|
```
|
Loading…
Add table
Reference in a new issue