Real content added

Prerequisite, Setup and instructions how to run

Author: greifmatthias

README.md

@@ -1,27 +1,24 @@
-# Project
-
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 7.2.2.
-
-## Development server
-
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
-
-## Code scaffolding
-
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
-
-## Build
-
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
-
-## Running unit tests
-
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
-
-## Running end-to-end tests
-
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
-
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+# Electron-Angular
+This project is intended as a frame for Electron applications, with a UI build on Angular.
+The only thing that needs to be done to get this up and running is setting your own values for the application like name, description, ..
+
+## Prerequisite
+1. Npm must be installed
+2. Angular CLI must be installed
+
+## Setup project
+
+1. Setup the "package.json" file. Replace all content between "{{ }}" including "{{}}" with your own values:
+    * {{ApplicationName}} = Name of your application
+    * {{ApplicationDescription}} = Some description for your application
+    * {{AuthorName}} = Name of the publisher/maintainer/author/..
+    * {{AuthorEmail}} = Email, some support mail
+    * {{AppicationDomain}} = Unique identifier like "com.google.android" for example
+    * {{Copyright}} = Copyright for your application
+    * {{macApplicationCategory}} = Category for the application when on a Mac, [documentation about all the possible values](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8)
+    * {{SomeKeyWords}} = Comma-separated list of keywords referring to your application
+    
+2. Run "npm install" in root-directory of the application, this to install all required packages.
+
+## Run the application
+Just run "npm run electron"