From d901d1f5fa85a3ac56123b665ace38575627df14 Mon Sep 17 00:00:00 2001 From: vlw Date: Wed, 25 Sep 2024 14:47:41 +0000 Subject: [PATCH] doc(chore): change prerequisites and vv env var --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 24869fb..cf40ab1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,13 @@ This is the source code behind [vlw.se](https://vlw.se) which has been written f # Installation If you for whatever reason want to get this website up and running for yourself this is how that is done. -This website is built for PHP 8.0+ and MariaDB 14+ (for the API database). +## This website requires the following prerequisites +- [PHP 8.0+](https://www.php.net/) +- [MariaDB 14+](https://mariadb.org/) +- [The NPM package manager](https://www.npmjs.com/) +- [The Reflect API framework](https://reflect.vlw.se) +- [The Vegvisir web framework](https://vegvisir.vlw.se) +- [The composer package manager](https://getcomposer.org/) **Confimed supported framework versions:** Vegvisir|Reflect @@ -20,7 +26,7 @@ Vegvisir|Reflect ``` 2. **Download and install Vegvisir** - Follow the installation instructions for [Vegvisir](https://vegvisir.vlw.se/docs/installation) and point the `site_path` variable to the local vlw.se folder. + Follow the installation instructions for [Vegvisir](https://vegvisir.vlw.se/docs/installation) and point the `root_path` variable to your local vlw.se folder. 3. **Run the install script**