Parcourir la source

Update readme

Instruction how to compile the code.
Ecconia il y a 7 ans
Parent
commit
bdf954985d
1 fichiers modifiés avec 17 ajouts et 19 suppressions
  1. 17 19
      README.md

+ 17 - 19
README.md

@@ -1,26 +1,24 @@
-# rs-rewrite
+# Website for RedstoneServer
+This is a rewrite of the current website for the RedstoneServer.
 
-## Project setup
-```
-npm install
-```
+## Usage
+- You may not host this sourcecode for public access.
+- You may use this sourcecode to contribute to it.
+- You may look at it to learn web developing.
 
-### Compiles and hot-reloads for development
-```
-npm run serve
+## Setup
+This website uses the framework Vue with webpack. To look at the website, it has to be compiled.
 ```
+# Install:
+- nodejs v8.10.0+ (nodejs.org)
+- npm 6.4.1+ (installed with nodejs)
 
-### Compiles and minifies for production
-```
-npm run build
-```
+# Get dependencies:
+npm i
 
-### Run your tests
-```
-npm run test
-```
+# Start testserver:
+npm run serve
 
-### Lints and fixes files
-```
-npm run lint
+# Compile a final minified version:
+npm run build
 ```