add authors, remove link to GitLab

[bbcp.git] / README

diff --git a/README b/README
index 28b4fb3e8b9d95613eadfa9b3a9bd431b84a5e3f..09e7d73534b7901a0403e38902741da66e73faea 100644 (file)
--- a/README
+++ b/README
@@ -1,39 +1,53 @@
-Ducumentation (Russian):
+Directories structure:
 
-       http://gitlab.molpit.com/idenisov/blackbox-linux/wikis/home
+       BlackBox/
+               universal development environment based on BlackBox 1.7
 
-Directories structure:
+       examples/
+               encoder/ - encoding BlackBox subsystem by StdCoder from command line interface
+               fpstest/ - loop and fonts test
+               server/ - static single-thread web-server
 
-       new/
-               universal development environment
-               synchronized with original BlackBox 1.6
+Installation of required packages in Ubuntu 14.04-16.04 (should work also with other Debian-based OS):
 
-       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
+       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
 
-To build BlackBox:
+       64-bit version:
+               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
 
-       cd new
+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>
 
-Example: build, create assembly in /tmp, run BlackBox from assembly:
-       cd new
+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 /tmp/BlackBox-`uname -s`
-       cd /tmp/BlackBox-`uname -s`
+       ./export ../`uname -s`_GUI
+       ./switch-target none
+       ./clean
+       cd ../`uname -s`_GUI
        ./run-BlackBox
+
+(c) Alexander V. Shiryaev, Igor A. Dehtyarenko, Ivan A. Denisov
+