DEADSOFTWARE

update example for encoding subsystems
[bbcp.git] / README
diff --git a/README b/README
index 1cde2ecb00b63e5ff13d983fbfe362835f7b6f71..fbde840fc2f60a4b4d5f05feeb203fe8c68916b3 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,66 @@
-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/oberon/blackbox-freenix/wikis/home
+
+Directories structure:
+
+       BlackBox/
+               universal development environment
+               synchronized with original BlackBox 1.6
+
+       examples/
+               some outdated examples
+               console/
+                       simple console application
+               fpstest/
+                       loop test
+               server/
+                       static web-server as the example of an application for Linux OS
+
+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
+       or
+       ./run-BlackBox-2
+
+To create BlackBox assembly (after build):
+
+       ./export <outputDirectory>
+
+To clean the BlackBox folder:
+       ./switch-target none
+       ./clean
+
+Example: build, create assembly in /tmp, run BlackBox from assembly:
+       cd BlackBox
+       ./switch-target `uname -s` GUI
+       ./build
+       ./export /tmp/BlackBox-`uname -s`
+       ./switch-target none
+       ./clean
+       cd /tmp/BlackBox-`uname -s`
+       ./run-BlackBox
+