updated some docs

1 files changed, 34 insertions, 0 deletions

diff --git a/doc/readme b/doc/readme
new file mode 100644
index 0000000..86f5970
--- /dev/null
+++ b/doc/readme
@@ -0,0 +1,34 @@
+abuild recipe guidance
+======================
+
+- please read all availabe *.readme files
+
+abuild recipe tree
+------------------
+name            - directory name, must be same as 'name' variable in abuild
+ |- abuild      - package recipe (required)
+ |- preinstall  - pre installation script (optional)
+ |- postinstall - post installation script (optional)
+ |- depends     - dependencies list, one package per line (optional)
+ |- .checksum   - source's b3sum, auto generated if not exist, can be manually generated using 'apkg -g'
+ \- .files      - packages file list, will be generated after packaging, can be manually generated using 'apkg -k'
+
+building package
+----------------
+
+- run 'apkg' inside package recipe directory.
+   or
+- run 'apkg <package name>' if package recipe is created inside APKG_REPO directory (you can run 'apkg -p <package name>' to
+  print <package name>'s path if its in APKG_REPO path).
+
+installing package
+------------------
+
+- run 'apkg -i' or 'apkg -i <package name>' (same case as above).
+   or
+- run 'spm -i <path to prebuilt package file>' directly (installing this way will not execute pre/postinstall script and will
+  not trigger system database updates, you recomended to run 'apkg -t' afterwards)
+
+NOTE:
+- 'apkg -t' will update font cache, mime database, desktop database, gtkimodules, glib schema, giomodules and gdkpixbuf cache.
+- this trigger will automatically detected on which packages need to run.