markup fixed

[bbcp.git] / README

diff --git a/README b/README
index 066db262db189ee0d44605d8fb5f483f2a5f2efe..ded79f3643011ad6e2104f84fa46d3b4e86cda31 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,75 @@
-old: old branch based on BlackBox.Linux.20050512.zip; will be removed later
+BlackBox Component Builder port for OpenBSD, GNU/Linux, FreeBSD
 
-new: head branch, mostly based on Trurl work done in 2006
-       synchronized with original BlackBox-1.6
+Repository includes version for Windows also.
+
+Tested on:
+* OpenBSD 6.0
+* Fedora Core 17
+* Ubuntu 14.04, 16.04 LTS
+* FreeBSD 11.0
+
+Directories structure:
+
+       BlackBox/
+               universal development environment based on BlackBox 1.7
+
+       examples/
+               encoder/ - encoding subsystems by StdCoder from the command line
+               fpstest/ - loop and fonts test
+               server/ - static single-thread web-server
+
+Installation of required packages in Ubuntu (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 gnome-icon-theme-full
+
+       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
+
+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
+
+Authors:
+* Oberon microsystems AG
+* BlackBox Framework Center
+* Alexander V. Shiryaev
+* Igor A. Dehtyarenko
+* Ivan A. Denisov
 
-ubuntu: old (1.6-rc6) copy of "new" branch for Ubuntu
-       maintainer of this branch is Ivan Denisov