Initial commit

README.md

@@ -0,0 +1,88 @@
+<div align="center">
+  <span align="center"> <img width="80" height="70" class="center" src="https://github.com/kjlaw89/archetype/blob/master/data/images/com.github.kjlaw89.archetype.png" alt="Icon"></span>
+  <h1 align="center">Archetype</h1>
+  <h3 align="center">Create new Vala projects with ease</h3>
+</div>
+
+<br/>
+
+<p align="center">
+    <a href="https://appcenter.elementary.io/com.github.kjlaw89.archetype">
+        <img src="https://appcenter.elementary.io/badge.svg">
+    </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/kjlaw89/archetype/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/License-GPL--3.0-blue.svg">
+  </a>
+  <a href="https://github.com/kjlaw89/archetype/releases">
+    <img src="https://img.shields.io/badge/Release-v%201.0.0-orange.svg">
+  </a>
+</p>
+
+<p align="center">
+    <img  src="https://github.com/kjlaw89/archetype/blob/master/data/images/screenshot.png" alt="Screenshot"> <br>
+  <a href="https://github.com/kjlaw89/archetype/issues/new"> Report a problem! </a>
+</p>
+
+## Installation
+
+### Dependencies
+These dependencies must be present before building:
+ - `meson (>=0.40)`
+ - `valac (>=0.16)`
+ - `debhelper (>= 9)`
+ - `libgranite-dev`
+ - `libgtk-3-dev`
+
+Use the App script to simplify installation by running `./app install-deps`
+
+ ### Building
+
+```
+git clone https://github.com/kjlaw89/archetype.git && cd archetype
+./app install
+```
+
+### Deconstruct
+
+```
+./app uninstall
+```
+
+### Development & Testing
+
+Archetype and all projects that are generated by it include a simple script to simplify the development process. This script lives in the main project directory and can be accessed by `./app`. This script simplifies many of the common actions that are needed to develop an app. When developing we suggest you use `./app test-run` as this will run any unit tests for the application first before starting the application up.
+
+```
+Usage:
+  ./app [OPTION]
+
+Options:
+  clean             Removes build directories (can require sudo)
+  generate-i18n     Generates .pot and .po files for i18n (multi-language support)
+  install           Builds and installs application to the system (requires sudo)
+  install-deps      Installs missing build dependencies
+  run               Builds and runs the application
+  test              Builds and runs testing for the application
+  test-run          Builds application, runs testing and if successful application is started
+  uninstall         Removes the application from the system (requires sudo)
+```
+
+### Contributing
+
+To help, access the links below:
+
+- [Guide on Code Style](https://github.com/kjlaw89/Archetype/wiki/Guide-on-code-style)
+
+- [Proposing Design Changes](https://github.com/kjlaw89/Archetype/wiki/Proposing-Design-Changes)
+
+- [Reporting Bugs](https://github.com/kjlaw89/Archetype/wiki/Reporting-Bugs)
+
+- [Translate](https://github.com/kjlaw89/Archetype/wiki/Translate)
+
+
+### License
+
+This project is licensed under the GPL3 License - see the [LICENSE](LICENSE.md) file for details.