Build instructions & Status progress

README.md

@@ -2,12 +2,32 @@
 
 Bindings are based on [DOtherSide](https://github.com/filcuc/dotherside) C bindings for QML Library is mostly feature-compliant with other bindings based on the library, but lacks some minor features and has quite a few bugs.
 
-# Preview:
+# Preview
 ![qml_zig](https://user-images.githubusercontent.com/6756180/102698635-a5518500-421d-11eb-8705-98013d2328d7.jpg)
 
-# Status:
+# Build - Steps
 
-Initial
+## Requirements
+
+All software required for building.
+
+- Qt 5.14 or higher
+- Zig v0.7.1 or higher
+- C++ compiler w/ C++11 support
+- CMake v3.2 or higher (DOtherSide build)
+
+## Instructions
+
+~~~bash
+# Clone repo
+git clone --recursive https://github.com/kassane/qml_zig
+
+# Open folder
+cd qml_zig
+
+# Build
+zig build ExampleName -Drelease-safe|-Drelease-fast|-Drelease-small
+~~~
 
 # Examples
 
@@ -29,3 +49,15 @@ Initial
 
 `zig build Particle` - Particle system example
 - Needs QObject wrapper working yet, to pass zig objects to the QML side
+
+# Status
+
+- Basic initialization and execution
+- More Examples - thanks [@zigster64](https://github.com/zigster64)!
+- Providing properties to QML files
+
+# TODO
+
+- [ ] QAbstractListModels
+- [ ] QObject - **working progress**
+- [ ] QStyle