diff --git a/README.md b/README.md index 3163987..10f6de1 100644 --- a/README.md +++ b/README.md @@ -40,13 +40,11 @@ In case you use normal Command prompt you will have to locate where msbuild is i You can additionally specify platform with`/p:Platform=x86` argument. Available options are `x64` (64-bit) and `x86` (32-bit). - - Alternatively you can download Windows executables from this [release](https://gitlab.mff.cuni.cz/abraham1/celat/-/releases/v1). ## Usage - + A grid of the automaton is located on the left side. You can click each individual cell to cycle its state to a next one. On the right side a control panel is located. @@ -58,12 +56,13 @@ In the first textbox you can define cells of the automaton. Each definition needs to be on separate line, empty lines will be ignored. -**Format:** NAME,COLOUR +**Format:** NAME,COLOUR,PROBABILITY -| Name | Description | -| ------ | ------------------------------------------------------------------------------------ | -| NAME | name of the cell type, only letter of English alphabet should be used, no whitespace | -| COLOUR | hexadecimal RGB representation of a cell colour | +| Name | Description | +| ----------- | ------------------------------------------------------------------------------------ | +| NAME | name of the cell type, only letter of English alphabet should be used, no whitespace | +| COLOUR | hexadecimal RGB representation of a cell colour | +| PROBABILITY | probability of this cell appearing when board is randomly generated | **Examples**: @@ -138,6 +137,8 @@ This automaton almost always results in chaotic growth, randomizing the board is ### Other functionalities +**SET BOARD SIZE** - set size of the board, application will restart and all settings will be reset! + **ONE STEP** - advances the automaton by one evolution **RANDOMIZE BOARD** - every cell is set to random state diff --git a/docs/documentation.md b/docs/documentation.md index 029d34e..e02e4d2 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -14,9 +14,11 @@ Součástí projektu je uživatelská dokumentace obsahující návod k instalac Projekt jsem rozdělil na dvě hlavní části - knihovna implementující univerzální automat a uživatelské rozhraní používající tuto knihovnu. + + **Ukázka rozhraní:** - + ## Pravidla diff --git a/docs/documentation.pdf b/docs/documentation.pdf index 2469da4..878253b 100644 Binary files a/docs/documentation.pdf and b/docs/documentation.pdf differ diff --git a/docs/images/celat2.png b/docs/images/celat2.png new file mode 100644 index 0000000..d8581e6 Binary files /dev/null and b/docs/images/celat2.png differ diff --git a/docs/user_guide.md b/docs/user_guide.md index ffaeae8..c222232 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -44,7 +44,7 @@ Alternatively you can download Windows executables from this [release](https://g ## Usage - + A grid of the automaton is located on the left side. You can click each individual cell to cycle its state to a next one. On the right side a control panel is located. @@ -56,12 +56,13 @@ In the first textbox you can define cells of the automaton. Each definition needs to be on separate line, empty lines will be ignored. -**Format:** NAME,COLOUR +**Format:** NAME,COLOUR,PROBABILITY -| Name | Description | -| ------ | ------------------------------------------------------------------------------------ | -| NAME | name of the cell type, only letter of English alphabet should be used, no whitespace | -| COLOUR | hexadecimal RGB representation of a cell colour | +| Name | Description | +| ----------- | ------------------------------------------------------------------------------------ | +| NAME | name of the cell type, only letter of English alphabet should be used, no whitespace | +| COLOUR | hexadecimal RGB representation of a cell colour | +| PROBABILITY | probability of this cell appearing when board is randomly generated | **Examples**: @@ -134,10 +135,10 @@ Dead cell becomes alive if it has two alive neighbours. This automaton almost always results in chaotic growth, randomizing the board is recommended with this one. - - ### Other functionalities +**SET BOARD SIZE** - set size of the board, application will restart and all settings will be reset! + **ONE STEP** - advances the automaton by one evolution **RANDOMIZE BOARD** - every cell is set to random state diff --git a/docs/user_guide.pdf b/docs/user_guide.pdf index 678d153..252594c 100644 Binary files a/docs/user_guide.pdf and b/docs/user_guide.pdf differ