--- a/README
+++ b/README
-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
-ubuntu: copy of "new" branch (1.6-rc6) for Ubuntu
+Ducumentation (Russian):
+
+ http://gitlab.molpit.org/blackbox/freenix/wikis/home
+
+Directories structure:
+
+ BlackBox/
+ universal development environment
+ based on BlackBox 1.6
+ partly synchronized with BlackBox 1.7-beta
+
+ examples/
+ console/
+ simple console application (demonstration for ConsCompiler and ConsLog)
+ encoder/
+ encoding BlackBox subsystem by StdCoder from command line interface
+ fpstest/
+ loop test
+ server/
+ static single-thread web-server
+
+Installation of required packages in Ubuntu 14.04 (should work also with other Debian-based OS):
+
+ 32-bit version:
+ sudo apt-get install libgtk2.0-0 gtk2-engines gtk2-engines-murrine libcanberra-gtk-module
+ sudo apt-get install libgnomeui-0
+
+ 64-bit version:
+ sudo apt-get install libc6-dev-i386
+ sudo dpkg --add-architecture i386
+ sudo apt-get update
+ sudo apt-get install libgtk2.0-0:i386 gtk2-engines:i386 gtk2-engines-murrine:i386 libcanberra-gtk-module:i386
+ sudo apt-get install libgnomeui-0:i386
+
+ Comments:
+ 'libc6-dev-i386' is required for compilation of 'loader', after build it can be replaced by 'libc6-i386'
+ 'libgnomeui-0:i386' is required only for run blackbox by 'run-BlackBox-2' starter
+
+
+To build BlackBox:
+ cd BlackBox
+ ./switch-target `uname -s` GUI
+ ./build
+
+To run BlackBox (after build):
+
+ ./run-BlackBox
+ for Linux version also you can run
+ ./blackbox
+
+To create BlackBox assembly (after build):
+
+ ./export <outputDirectory>
+
+To clean the BlackBox folder:
+ ./switch-target none
+ ./clean
+
+Example: build, create assembly and run BlackBox from assembly:
+ cd BlackBox
+ ./switch-target `uname -s` GUI
+ ./build
+ ./export ../`uname -s`_GUI
+ ./switch-target none
+ ./clean
+ cd ../`uname -s`_GUI
+ ./run-BlackBox
+