added README
This commit is contained in:
parent
f34603f7da
commit
851dd06f44
34
README.md
Normal file
34
README.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
IRS Software Website
|
||||||
|
=======
|
||||||
|
|
||||||
|
This website shows the software projects of the satellite division at the Institute of Space
|
||||||
|
Systems of the University of Stuttgart.
|
||||||
|
|
||||||
|
# Development
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
1. Install [hugo](https://gohugo.io/)
|
||||||
|
2. Install [node](https://nodejs.org/en)
|
||||||
|
|
||||||
|
## Building the website
|
||||||
|
|
||||||
|
1. Install the npm dependencies first.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Build the website locally.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
hugo serve --open
|
||||||
|
```
|
||||||
|
|
||||||
|
## Generating the website
|
||||||
|
|
||||||
|
The website can be built into the `public` folder by running
|
||||||
|
|
||||||
|
```sh
|
||||||
|
hugo
|
||||||
|
```
|
Loading…
x
Reference in New Issue
Block a user