synchronized with https://github.com/aixp/BlackBox

[bbcp.git] / README

diff --git a/README b/README
old mode 100644 (file)
new mode 100755 (executable)
index 8bc9c16..01880ab
--- a/README
+++ b/README
@@ -1,51 +1,64 @@
-** Ducumentation (Russian): **
+Ducumentation (Russian):
 
-   http://gitlab.molpit.com/idenisov/blackbox-linux/wikis/home
+       http://gitlab.molpit.org/blackbox/freenix/wikis/home
 
+Directories structure:
 
-** Folders structure: **
+       BlackBox/
+               universal development environment
+               based on BlackBox 1.7-beta1
 
-./new/
-    universal development environment
-    synchronized with original BlackBox 1.6
+       examples/
+               encoder/
+                       encoding BlackBox subsystem by StdCoder from command line interface
+               fpstest/
+                       loop test
+               server/
+                       static single-thread web-server
 
-./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
-         
-** Installation **
+Installation of required packages in Ubuntu 14.04 (should work also with other Debian-based OS):
 
-1. For creating links in development directory run:
+       32-bit version:
+               sudo apt-get install libgtk2.0-0 gtk2-engines gtk2-engines-murrine libcanberra-gtk-module
+               sudo apt-get install libgnomeui-0 gnome-icon-theme-full
 
-    cd ./new
-    ./README
+       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 gnome-icon-theme-full
 
-   To start:
+       Comments:
+               'libc6-dev-i386' is required for compilation of 'loader', after build it can be replaced by 'libc6-i386'
 
-    ./run-BlackBox
 
-2. For creating assembly for target OS in development directory run:
+To build BlackBox:
+       cd BlackBox
+       ./switch-target `uname -s` GUI
+       ./build
 
-    cd ./new
-    ./export (Linux|OpenBSD|FreeBSD) (GUI|)
+To run BlackBox (after build):
 
-   Example for Linux:
+       ./run-BlackBox
+       for Linux version also you can run
+       ./blackbox
 
-    ./export Linux GUI
-    
-   Then:
+To create BlackBox assembly (after build):
 
-    cd ../Linux_GUI
-    ./build
+       ./export <outputDirectory>
 
-   To start with .so loader:
+To clean the BlackBox folder:
+       ./switch-target none
+       ./clean
 
-    ./run-BlackBox
+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
 
-   To start with .ELF loader
-    
-    ./run-BlackBox-2