Browse Source

Readme update

flabbet 6 years ago
parent
commit
3a3c145f57
1 changed files with 36 additions and 0 deletions
  1. 36 0
      README.md

+ 36 - 0
README.md

@@ -0,0 +1,36 @@
+# PixiEditor
+Pixi is lightweighted pixel art creator.
+
+## Getting started with Pixi
+
+Follow these instructions to get Pixi working on your machine.
+
+### Software Requirements
+
+```
+.NET Framework 4.6.1
+```
+
+### Installing
+
+1. Download this file: [Link](https://www.somelink.com)
+
+2. Open installer 
+
+3. Follow installer instructions
+
+## Built with
+
+* [Extended WPF Toolkit](https://github.com/xceedsoftware/wpftoolkit) - More controls and themes for WPF
+* [WriteableBitmapEx](https://github.com/teichgraf/WriteableBitmapEx/) - Collection of extension methods for the XAML WriteableBitmap
+
+## Contributing 
+
+Please read [CONTRIBUTING.md](https://github.com/flabbet/PixiEditor/CONTRIBUTING.md/) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Authors
+* **Krzysztof Krysiński** *Creator of the project* - [flabbet](https://github.com/flabbet)
+
+## License
+
+This project is licensed under the GNU GPLv3 License - see the [LICENSE.md](https://github.com/flabbet/PixiEditor/blob/master/LICENSE) - file for details