export simplified, READMEs clarified

[bbcp.git] / README

diff --git a/README b/README
index 1cde2ecb00b63e5ff13d983fbfe362835f7b6f71..df987b3949463bf5ca9f2be1f9b47119bbbc9225 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,41 @@
-old: old branch based on BlackBox.Linux.20050512.zip; will be removed later
-new: head branch, mostly based on Trurl work done in 2006
-       synchronized with BlackBox-1.6-rc6
-ubuntu: copy of "new" branch for Ubuntu
+Ducumentation (Russian):
+
+       http://gitlab.molpit.com/idenisov/blackbox-linux/wikis/home
+
+Directories structure:
+
+       new/
+               universal development environment
+               synchronized with original BlackBox 1.6
+
+       examples/ (all axamples are not tested on `new` version yet)
+               server/
+                       static web-server as the example of an application for Linux OS
+               console/
+                       simple console application
+               fpstest/
+                       loop test
+
+To build BlackBox:
+
+       cd new
+       ./switch-target `uname -s` GUI
+       ./build
+
+To run BlackBox (after build):
+
+       cd new
+       ./run-BlackBox
+
+To create BlackBox assembly (after build):
+
+       cd ./new
+       ./export <outputDirectory>
+
+Example: build, create assembly in /tmp, run BlackBox from assembly:
+       cd new
+       ./switch-target `uname -s` GUI
+       ./build
+       ./export /tmp/BlackBox-`uname -s`
+       cd /tmp/BlackBox-`uname -s`
+       ./run-BlackBox