Aktualisieren README.md

README.md

@@ -1,2 +1,42 @@
-# Random user
+# Random user
-
+Online preview: http://theenoro.the-co.de/random-user/
+
+
+
+## Download
+### Build yourself
+NodeJS: https://nodejs.org/en/
+```bash
+git clone https://gitlab.thee.moe/theenoro/random-user.git
+cd random-user
+npm install 
+npm install -g less
+npm run build --prod 
+cp public/index.html public/404.html 
+mv public _public 
+mv build public
+lessc src_less/main.less build/main.css
+mv public build
+```
+### Latest Artifact
+https://gitlab.thee.moe/theenoro/random-user/-/jobs/artifacts/master/download?job=pages
+
+## Usage
+### Get it running
+Just use a simple webserver, if you want to use the rescan.php then you need php-cli or something like apache/nginx with the php module.
+### Create new Classes / Usergroups w/o rescan.php
+1. create in `build/data/class` a new folder for a new group of users
+2. modify the `classes.json` in `build/data/class` and add in the array your ne folder name
+3. create in your new folder a file with the name 'user.json' and a structure like 
+```json
+{"user":[
+        ["<file_name(w/o filetype)>","<filetype>"],
+        ["test","jpg"],
+    ]
+}
+
+```
+### Create new Classes / Usergroups w/ rescan.php
+1. create in `build/data/class` a new folder for a new group of users
+2. run in the build folder `php ./rescan.php`, it will generate the `classes.json` and all `user.json` files for you
+