diff --git a/README.md b/README.md index b19bfe3..e885694 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ -# ZISS-Kernel 2.0 +![](public/nope/logo.png) -Dynamic-Backend Combining nextjs and openapi +# No Programming Environment - `NoPE` + +`NoPE` is a distributed system. The `NoPE` is a basic concept to link modules to a system. These modules can run on multiple nodes (computation nodes) and `NoPE` takes care of coupling them. +Although, `NoPE` provides a basic setup for `next.js` as front-end + +# Installation. + +## Installing using Batch-File (Windows ONLY) + +> This approach works on windows only. + +To install `NoPE` just extecute the `00-install.bat`-Batch-File in the root-directory. + +## Manual Installation + +Make shure you run the following tasks + +1. `npm install` +2. `npx tsc -p ./tsconfigBackend.json --pretty` +3. `npm link` + +# Usage + +## NoPE - Command Line Interface. + +After installation you can use the following cli-tool: + +> `nope` + +Please select the option you want. Therefore add one of the following options: + +- `help` - Opens the Help +- `run` - Start a NoPE-Backend. +- `init` - Initialize a new project. This project is empty. +- `scan` - Trys to update the configuration file.