Merge branch 'master' of http://git.roojs.com/roobuilder

[roobuilder] / README.md

diff --git a/README.md b/README.md
index 25333d8..afe14d5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,85 @@
-# roojsbuilder
+# roobuilder
 Vala and Javascript IDE - for building Vala Desktop applications and Javascript UI's using the roojs libraries (for bootstrap and classic)
 
+---
+**Videos** 
+
+GLib Settings Demo
+
+Part 1 - click to view on youtube
+
+[![GLib Settings Demo Part 1](https://i.ytimg.com/vi/kx4B0frG-vc/hqdefault.jpg)](https://www.youtube.com/watch?v=kx4B0frG-vc&t=20s "GLib Settings Demo Part 1 - Click to Watch!")
+
+Part 2 - click to view on youtube
+
+[![GLib Settings Demo Part 2](https://i.ytimg.com/vi/XChS0YEB4yY/hqdefault.jpg)](https://www.youtube.com/watch?v=XChS0YEB4yY&t=6s "GLib Settings Demo Part 2 - Click to Watch!")
 
 ---
+**Changlog** 
+
+  https://github.com/roojs/roobuilder/blob/master/debian/changelog
 
-Building it
+---
+**Features Wishlist** 
 
-    a) Remove vala and install packages from here.
+    Random list of ideas to add - I regulary add these in totally random order.
     
-    apt-get remove vala* libvala* 
-    Download vala*.deb, libvala*.deb,  and roojspacker*.deb
-    https://www.dropbox.com/sh/730btm3yn6jtplh/AABbRFzK6bI6BoHQIMfh3A4Ia?dl=0
-    dpkg -i libvala* vala*  roojspacker*
+    https://docs.google.com/spreadsheets/d/1-qNQX1Bwwd1cV405Kj1l3B3Mi6K-GvECnMeuzRKfbGA/edit?usp=sharing
     
-    b) git clone https://github.com/roojs/roobuilder.git
+---
+**Debian and Ubuntu packages** 
+
+ you will need libvala (available on most debian/ubuntu repos), 
+   and vala-language-server (available below)
+ 
+Dependancies
+
+  * https://github.com/roojs/vala-language-server/releases 
+  * https://github.com/roojs/roojspacker/releases
+  
+Release
+
+  * https://github.com/roojs/roobuilder/releases
+  
+---
+
+**Building it** 
+
+  a) Clone this code..
+  
+    git clone https://github.com/roojs/roobuilder.git
+    
+  b) configure it.
+  
+    meson setup build --prefix=/usr
     
-    c) ./autogen.sh --prefix=/usr
+  c) make make install
+  
+    ninja -C install
+    
+  e) run it
+
+    roobuilder
     
-    d) sudo make install
+---
+
+**Notes on updating packaging..** 
+
+Update Package details.
+    Edit the about version (check debian/changelog)
     
-    e) run it
+    dch -U -i (auto increases release..)
+    dch -v {release version}
+
+Build it..
+
+    dpkg-buildpackage -rfakeroot -us -uc -b
+
+    flatpak-builder --force-clean --sandbox --user --install --mirror-screenshots-url=https://dl.flathub.org/repo/screenshots --repo=repo build-dir org.roojs.roobuilder.json
+
+---
+
+**Known issues** 
 
-    #roobuilder
\ No newline at end of file
+  * Flatpack -  run doesnt work - needs more work understanding how flatpack would manage to compile with libraries from the system, or inside the pack
+  * See the wishlist..
\ No newline at end of file