DEADSOFTWARE

new -> BlackBox
[bbcp.git] / README
diff --git a/README b/README
index edbcd4732aeab29987c56e1b098891eb9b10a9c2..5af69d54bd3132781938f50156752eb2d4ca83bd 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,41 @@
-./new/
-    universal development environment
-    synchronized with original BlackBox 1.6
-
-./examples/
-    /server/
-         static web-server as the example of an application for Linux OS
-    /console/
-         simple console application
-    /fpstest/
-         loop test
+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
+
+               server/
+                       static web-server as the example of an application for Linux OS
+               console/
+                       simple console application
+               fpstest/
+                       loop test
+
+To build BlackBox:
+
+       cd BlackBox
+       ./switch-target `uname -s` GUI
+       ./build
+
+To run BlackBox (after build):
+
+       ./run-BlackBox
+
+To create BlackBox assembly (after build):
+
+       ./export <outputDirectory>
+
+Example: build, create assembly in /tmp, run BlackBox from assembly:
+       cd BlackBox
+       ./switch-target `uname -s` GUI
+       ./build
+       ./export /tmp/BlackBox-`uname -s`
+       cd /tmp/BlackBox-`uname -s`
+       ./run-BlackBox