link for the external compiler documentation was updated

[bbcp.git] / README

diff --git a/README b/README
index e510349b822c2d29fb09a449867e7a3c6b27b174..46b93157021ac2cf51ae3c1d63a667008a1fda4f 100644 (file)
--- a/README
+++ b/README
@@ -1,18 +1,77 @@
-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 original BlackBox 1.6
-
-ubuntu: copy of "new" branch for Ubuntu, synchronized with bb16base-core.7z
-       these files differ between bb16base-core.7z and original BlackBox 1.6:
-               Dev/Mod/Commanders.odc
-               Dev/Mod/Compiler.odc
-               Dev/Mod/Debug.odc
-               Dev/Mod/Packer.odc
-               Sql/Mod/DB.odc
-               Sql/Mod/Odbc3.odc
-               Std/Mod/Folds.odc
-               Std/Mod/Links.odc
-               Std/Mod/Stamps.odc
-               System/Mod/Windows.odc
-       maintainer of this branch is Ivan Denisov
+BlackBox Component Builder for Windows, GNU/Linux, OpenBSD, FreeBSD
+
+Tested on:
+* Windows XP,7,10
+* OpenBSD 6.0
+* Fedora Core 17
+* Ubuntu 14.04, 16.04 LTS
+* Ubuntu GNOME 17.04
+* Arch Linux 4.9.6
+* Debian Mate
+* Red Hat Enterprise Linux Server 6.3
+* FreeBSD 11.0
+
+Directories structure:
+
+       BlackBox/
+               universal development environment based on BlackBox 1.7
+
+       examples/
+               encoder/ - encoding subsystems by StdCoder from the command line
+               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
+