update readme

This commit is contained in:
Ulf Gebhardt 2023-01-03 01:17:20 +01:00
parent b864cea8cf
commit 05bdc3f6cc
Signed by: ulfgebhardt
GPG Key ID: DA6B843E748679C9

View File

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