Merge pull request #63 from NBprojekt/feature/readme

Create some basic readme files

README.md

@@ -0,0 +1,99 @@
+<p align="center">
+  <a href="https://github.com/nbprojekt/stack-app">
+    <img src="./resources/icon.png" width="150">
+  </a>
+</p> 
+
+<h2 align="center"> <b> Stack App </b> </h2>
+<h4 align="center"> A lightweight frontend for all Stack Exchange sited for Android and iOS. </h4>
+
+[//]: # (Pipes)
+<p align="center">
+  <a href="https://github.com/nbprojekt/stack-app/releases/latest" alt="App Version">
+    <img src="https://img.shields.io/badge/dynamic/json?color=informational&label=version&query=tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnbprojekt%2Fstackapp%2Freleases%2Flatest">
+  </a>
+
+  <a href="https://github.com/NBprojekt/stack-app/actions?query=workflow%3A%22Github+CI%22">
+    <img src="https://github.com/nbprojekt/stack-app/workflows/Github%20CI/badge.svg" alt="Ionic CI Status">
+  </a>
+
+  <a href="https://github.com/NBprojekt/stack-app/actions?query=workflow%3A%22Android%22">
+    <img src="https://github.com/nbprojekt/stack-app/workflows/Android/badge.svg" alt="Android">
+  </a>
+
+  <a href="">
+    <img src="https://img.shields.io/badge/iOS-comming%20soon-lightgrey" alt="iOS">
+  </a>
+</p>
+
+<hr>
+
+[//]: # ()
+<p align="center">
+  <a href="#description"> Description </a> &bull;
+  <a href="#screenshots"> Screenshots </a> &bull;
+  <a href="#bugs-and-features"> Bugs and features </a> &bull;
+  <a href="#development"> Development </a> &bull;
+  <a href="#contributing"> Contributing </a> &bull;
+  <a href="#donate"> Donate </a> &bull;
+  <a href="#license"> License </a>
+</p>
+
+<hr>
+
+> WARNING: THIS IS A BETA VERSION, THEREFORE YOU MAY ENCOUNTER BUGS. IF YOU DO, OPEN AN ISSUE VIA OUR GITHUB REPOSITORY.
+
+## Description
+
+## Screenshots
+<div align="center" width="100%">
+  <img width="32%" src="https://user-images.githubusercontent.com/24683383/110446790-d8d6d980-80bf-11eb-83d3-ad24c9abf452.png">
+  <img width="32%" src="https://user-images.githubusercontent.com/24683383/110446810-de342400-80bf-11eb-8e1b-4d63fdccb135.png">
+  <img width="32%" src="https://user-images.githubusercontent.com/24683383/110446802-dc6a6080-80bf-11eb-8f19-084097a1a962.png">
+</div>
+
+
+## Bugs and features 
+Found a bug? Explosions (that would be cool)? Do you want a new feature? Use the [issue tracker][1] here on GitHub to report issues and submit feature requests. 
+
+Search for your problem in the [issue section][1] before opening a new ticket. It might be already answered and save us time.<br>
+Before sumbitting a ticket read the [contribution guidelines][4]
+
+If not, use our templates for [bugs reports][2] and [feature requests][3]. <br>
+You will be asked some questions and requested to provide some information, please read them CAREFULLY and answer honestly.
+
+## Development
+This project requires [NodeJs][6] (>= v10.x.x) to run.
+
+Clone the project `https://github.com/NBprojekt/stack-app.git` and run `sudo npm run installation`.  
+Now you can launch the app by running `sudo npm start`.
+
+```
+git clone https://github.com/NBprojekt/stack-app.git
+cd stack-app
+sudo npm run installation
+sudo npm start
+```
+
+If you want to learn more about the scripts in this project check out the [script readme][8].
+> If you use windows make sure you are able to run bash scripts. You can simply install [gitbash][7].
+
+## Contributing
+Thanks for your interest in contributing! Read up on our guidelines for [contributing][4] and then look through our issues with a [help wanted][5] label.
+
+## Donate
+
+## License
+
+Stack App is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the [MIT License][9].
+
+[//]: # (Links)
+  [1]: https://github.com/nbprojekt/stack-app/issues
+  [2]: https://github.com/NBprojekt/stack-app/issues/new?assignees=&labels=bug&template=bug-report.md&title=
+  [3]: https://github.com/NBprojekt/stack-app/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+  [4]: https://github.com/NBprojekt/stack-app/blob/master/.github/CONTRIBUTING.md
+  [5]: https://github.com/NBprojekt/stack-app/labels/help%20wanted
+  [6]: https://nodejs.org/en/
+  [7]: https://gitforwindows.org/
+  [8]: https://github.com/NBprojekt/stack-app/blob/Feature-create-readme/scripts/README.md
+  [9]: https://github.com/NBprojekt/stack-app/blob/master/LICENSE

scripts/README.md

@@ -0,0 +1,78 @@
+## Scripts
+
+Overview of all available scripts and options.
+
+ + [Install](#install)
+ + [Start](#start)
+ + [Test](#test)
+ + [Lint](#lint)
+ + [Build](#build)
+ + [Emulate](#emulate)
+ + [Debug](#debug)
+ + [Sign](#sign)
+
+
+### Install
+If you just cloned this repository run this command. It will install all dependencies and configure cordova.  
+You have also the option to add platforms Android and iOS.
+
+> Note: [Ionic][1] and [Cordova][2] get installed globaly
+```
+  npm run installation
+```
+
+### Start
+Starts up ionic on `localhost:8100` and opens a new browser tab with the application.
+```
+npm start
+```
+
+### Test
+Start angular karma unit test.
+
+```
+npm test
+```
+
+### Lint
+Start linting according to your `tslint.json`.
+
+```
+npm run lint
+```
+
+### Build
+Build the app for `-a` Android (default) or `-i` iOS.  
+Outputfile can be found in `./platforms/android/app/build/outputs/apk/debug/`.
+
+```
+npm run build -- -a
+```
+
+### Emulate
+Emulate the app for `-a` Android (default) or `-i` iOS on a virtual device.  
+Also livereload is anabled and logs are displayed in the console.
+
+```
+  npm run emulate -- -a
+```
+
+### Debug
+just like the [emulate](#emulate) command only that it runs on a real device.  
+Also livereload is anabled and logs are displayed in the console.
+
+```
+npm run debug -- -a
+```
+
+### Sign
+Automatically  building and signing an APK with a given key.  
+Outputfile can be found in `./platforms/android/app/build/outputs/apk/release/stack-app.apk`.
+
+```
+npm run sign -- myKey
+```
+
+
+[1]: https://www.npmjs.com/package/ionic
+[2]: https://www.npmjs.com/package/cordova