Added initial Doxygen config file for generating documentation.

[wsti_so.git] / README

diff --git a/README b/README
index edcfffcff55f712ada851cfe9b5b0d695c42ee6a..f1bb2fa33be02ac79b7b4a1d5ef3a9497cf78303 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,40 @@
-Project created for passing Operating Systems subject in High School of Information Technology
\ No newline at end of file
+Project created for passing Operating Systems subject in
+High School of Information Technology
+
+
+Example usages
+--------------
+
+Without bootstrap program
+=========================
+
+In separate terminals enter:
+$ ./bin/process1
+$ ./bin/process2
+$ ./bin/process3
+
+After that in terminal with process1 running enter some characters followed by
+new line (ENTER).
+
+- Process1 displays information about data buffer and how many bytes has been
+  sent to process2.
+- Process2 displays information about received bytes, prints to stderr info
+  about number of characters in buffer, and sent this value to process3.
+- Process3 displays information about number of entered characters.
+
+With bootstrap program
+======================
+
+In terminal, go to the ./bin directory (where compiled programs resides).
+Execute:
+$ ./bootstrap
+
+After that there should be shown info about spawning new processess.
+You can now pass to the standard input of the first spawned process data, .e.g:
+$ echo "qwertyuiop" > /proc/(process 0 pid)/fd/3
+
+If process creation was completed without errors, you should see following output:
+[process2] Fetched: 11 bytes
+[process2] Calculated: 10 characters. Sending...
+[process3] Fetched: 4 bytes
+[process3] Process2 send: 10