update manual

Author: NeverBehave

ConwayGameOfLife/ConwayGameOfLife.tar.gz

@@ -0,0 +1,2 @@
+pandoc header-includes.yaml manual.md -o manual.pdf --pdf-engine=lualatex
+pandoc header-includes.yaml tests.md -o tests.pdf --pdf-engine=lualatex

ConwayGameOfLife/compile-pdf.sh

@@ -3,6 +3,65 @@
 This is the user manual of Conway Game of Life simulator.  
 You may find detail program usage and error message explanation here.
 
+## Examples Args  
+
+Please replace `...` with commands corresponed to your OS specify in `readme.md`.
+
+```bash
+... tests/example1.txt tests/result/example1 21
+... tests/example2.txt tests/result/example2 5
+... tests/example3.txt tests/result/example3 50
+```
+
+### Linux Example
+
+Here is how linux system should run the args, an example.
+
+```bash
+sh scripts/run.sh
+sh scripts/run.sh tests/example1.txt tests/result/example1 21
+sh scripts/run.sh tests/example2.txt tests/result/example2 5
+sh scripts/run.sh tests/example3.txt tests/result/example3 50
+sh scripts/run.sh tests/invalid1.txt tests/result/example1 1
+sh scripts/run.sh tests/invalid2.txt tests/result/example1 1
+sh scripts/run.sh tests/invalid3.txt tests/result/example1 1
+sh scripts/run.sh tests/invalid4.txt tests/result/example1 1
+sh scripts/run.sh tests/invalid5.txt tests/result/example1 1
+sh scripts/run.sh tests/invalid5.txt tests/result/example1 -1
+```
+
+### Bad Examples  
+
+```bash
+... tests/invalid1.txt tests/result/example1 1
+Err: [seedFile] Invalid row/col, must be positive integer larger than 2
+... tests/invalid2.txt tests/result/example1 1
+Err: [seedFile] Invalid row/col, must be positive integer larger than 2
+... tests/invalid3.txt tests/result/example1 1
+Err: [seedFile] Unexpected cell type 2
+... tests/invalid4.txt tests/result/example1 1
+Err: [seedFile] Unexpected col length at row index 1
+... tests/invalid5.txt tests/result/example1 1
+Cannot invoke "String.split(String)" because "<local1>" is null
+... tests/example3.txt tests/result/example1 -1
+Err: [input] step -1 is invalid
+```
+
+## Screenshot
+
+Here is an example screenshot of how it looks like when program runs, we will talk about each arguments in the following sections. 
+
+![](./screenshot.png)
+
+### Basic Usage
+
+If incorrect/missing arguments given, the following message will occur.
+
+```bash
+$ sh scripts/run/sh                                            
+Args: <input> <output> <step>
+```
+
 ## Inputs  
 
 In this section, program usage will be presented, as well as input file format.
@@ -97,31 +156,4 @@ When reading a specific cell in the seed file, program cannot recognize its stat
 
 ### `Cannot invoke "String.split(String)" because "<local1>" is null`  
 
-Seed file is possibly empty. Please check if correct seed file is given.
-
-## Examples Args  
-
-Please append the following with commands corresponed to your OS specify in `readme.md`
-
-```bash
-tests/example1.txt tests/result/example1 21
-tests/example2.txt tests/result/example2 5
-tests/example3.txt tests/result/example3 50
-```
-
-### Bad Examples  
-
-```bash
-... tests/invalid1.txt tests/result/example1 1
-Err: [seedFile] Invalid row/col, must be positive integer larger than 2
-... tests/invalid2.txt tests/result/example1 1
-Err: [seedFile] Invalid row/col, must be positive integer larger than 2
-... tests/invalid3.txt tests/result/example1 1
-Err: [seedFile] Unexpected cell type 2
-... tests/invalid4.txt tests/result/example1 1
-Err: [seedFile] Unexpected col length at row index 1
-... tests/invalid5.txt tests/result/example1 1
-Cannot invoke "String.split(String)" because "<local1>" is null
-... tests/example3.txt tests/result/example1 -1
-Err: [input] step -1 is invalid
-```
+Seed file is possibly empty. Please check if correct seed file is given.

ConwayGameOfLife/manuals/compile-pdf.sh

@@ -77,4 +77,6 @@ Commands to run these examples have also listed in the manual. It is believed th
 
 Game rules are also tested at `example2.txt` and `example3.txt` by stepping through the generated files.
 
-Some examples inspired by [wikipedia](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life).
+You may find the expected output in `tests/result` section. Use `diff` for the file generated from the program with corresponded command -- these should be identical or it means something goes wrong.
+
+Some examples inspired by [Wikipedia](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life).

ConwayGameOfLife/header-includes.yaml renamed to ConwayGameOfLife/manuals/header-includes.yaml

@@ -100,14 +100,14 @@ Open the powershell and nevigate to the project root directory
 
 Program usages, and test explanations
 
+#### `compile-pdf.sh`
+
+Compile `.md` file into `pdf`. `pandoc` used
+
 ### `tests/`
 
 Where examples/tests files stored. Read `manual.pdf` and `tests.pdf` for more info
 
 ### `deps/`
 
-Dependencies(jars) such as JUnit for consistent environment
-
-### `compile-pdf.sh`
-
-Compile `.md` file into `pdf`. `pandoc` used
+Dependencies(jars) such as JUnit for consistent environment