simiyutin · simiyutin · Mar 4, 2017 · Mar 6, 2017 · Mar 6, 2017 · Mar 7, 2017
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,6 @@
 /**/.idea/
 /**/build
+/**/*.vpp.*
+/**/*.iml
+/**/*.class
+/**/target/
diff --git a/README.md b/README.md
@@ -0,0 +1,44 @@
+# au_software_design
+
+##1. Shell
+
+###Command line utility similar to Unix shell.
+
+####Supported features:
+
+* echo command
+* cat command
+* wc command
+* exit command
+* pwd command
+* environment variables 
+* unknown commands are passed to system shell as separate process through Java.Process library.
+
+####Class diagram:
+![shell class diagram](https://www.gliffy.com/go/share/image/smx5dub0j39jxied850w.png?utm_medium=live-embed&utm_source=custom)
+
+####Data flow:
+  * Main: run Shell object.
+  * Shell: Read line from System.in.
+
+   * Preprocessor: Substitute environment variables in input string. E. g. "Hello, $name" -> "Hello, Alex"
+   * Tokeniser: Split string into a list of tokens: words and operators.
+   * Parser: Parse list of tokens as sequence of commands divided by pipes.
+   * Command Executor: Perform chained computation passing output of one comand as input to the next one.
+   * Pass result to System.in and loop again.
+
+
+##2. Grep
+###Command similar to UNIX grep utility.
+
+####Supports:
+* Reading from standard input or from file.
+* Parameters:
+ * -i: case insensivity.
+ * -w: whole words search.
+ * -A %number%: Number of lines to add to output after each matched line.
+
+####Implementation:
+* For regular expressions java.util.regex package is used.
+
+* For parsing command line arguments Apache Commons CLI library was chosen, because it is pretty easy to use and fits our requirements very well. Other libraries like JCommander and args4j were considered as an option, but were rejected as a little overkill at this point. If number of arguments will grow seriously, it may be reasonable to switch to one of these libraries, because of usage of annotations for introducing parameters.
diff --git a/book_store/book_store_class_diagram.vpp b/book_store/book_store_class_diagram.vpp
diff --git a/roguelike/arch/roguelike_class.svg b/roguelike/arch/roguelike_class.svg
diff --git a/roguelike/arch/roguelike_class_diagram.vpp b/roguelike/arch/roguelike_class_diagram.vpp
diff --git a/roguelike/arch/roguelike_component.svg b/roguelike/arch/roguelike_component.svg
diff --git a/roguelike/disdoc/architectural_drivers.md b/roguelike/disdoc/architectural_drivers.md
@@ -0,0 +1,3 @@
+Приложение консольное (ТЗ). Для отрисовки используем ASCIIPanel, потому что он предоставляет интерфейс для цветной графики по нему есть хороший мануал.
+Расширяемая иерархия классов персонажей(ТЗ).
+Для логирования используем LOG4j2, как гибкую и широко распространенную библиотеку логирования.