chore: readme with instructions
This commit is contained in:
40
README.md
Normal file
40
README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Linux VR Adventures Wiki
|
||||
|
||||
The Linux VR knowledge base!
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
You will need to install [Hugo extended](https://gohugo.io/installation/linux/).
|
||||
|
||||
### Cloning and submodules
|
||||
|
||||
You'll need to clone this repo with submodules or init your submodules after the fact.
|
||||
|
||||
#### Clone with submodules
|
||||
|
||||
```bash
|
||||
git clone https://gitlab.com/LVRA/wiki --recurse-submodules
|
||||
```
|
||||
|
||||
#### Init submodules in existing clone
|
||||
|
||||
```bash
|
||||
git submodule init
|
||||
git submodule update
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
You can run a live server with
|
||||
|
||||
```bash
|
||||
hugo serve
|
||||
```
|
||||
|
||||
## Building
|
||||
|
||||
```bash
|
||||
hugo
|
||||
```
|
||||
Reference in New Issue
Block a user