diff --git a/README.md b/README.md index f8e68d5..1146374 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # IT4C.dev -IT4C.dev Website + +This repository contains the https://IT4C.dev Website utilizing `vuepress` to generate it. + +## Software requirements + +This package requires: +- nodejs +- npm + +## Techstack + +This package uses: +- vuepress +- vuepress-theme-book + + +## Usage + +How to use this package + +### Build + +Build the static files of the website which then can be found under `docs/.vuepress/dist/`. +``` +npm run build +``` + +### Dev + +Bring up a development environment with hot reloading which can be reached under http://localhost:8080/ + +``` +npm run dev +``` \ No newline at end of file