Merge pull request #13 from t0mmili/docs/12-documentation-update

docs/12-documentation-update

README.md

@@ -1,22 +1,58 @@
 # DC Themer
 A free open source application aiming to complement the functionality of Double Commander with a theme switcher.
 
-## Key features
+## :fire: Key features
 * Switch themes instantly with just one click.
-* Backup configuration before applying new theme.
+* Backup DC configuration before applying new theme.
+* Get everything done via readable GUI.
+* Customize application configuration in json format.
 * For other planned cool features check [TODO.md](TODO.md).
 
-## Stack
+## :hammer: Stack
 DC Themer is written in [Python 3](https://www.python.org/), with the [Tkinter](https://wiki.python.org/moin/TkInter) package for the GUI.
 
-## Prerequisites
+## :clipboard: Prerequisites
 There are no special requirements to my knowledge.
 
 For the time being DC Themer is released as Windows binary, but feel free to pull the source code and run/compile on other machines.
 
-## Quick start
+## :rocket: Quick start (Windows)
 1. Download [DC Themer latest version](https://github.com/t0mmili/dc-themer/releases/latest).
 2. Download [themes]((https://github.com/t0mmili/dc-themes)) from my other GitHub repo.
 3. Put **schemes** folder next to **dc-themer.exe**.
 4. Run **dc-themer.exe**.
-5. Profit!
+5. For most cases the default configuration should be ok.  
+   If your DC is located in custom folder, adjust these keys in **dc-themer.json**:
+    ```json
+    {
+      ...
+      "doubleCommander": {
+        ...
+        "configPaths": {
+          "cfg": "%APPDATA%\\doublecmd\\doublecmd.cfg",
+          "json": "%APPDATA%\\doublecmd\\colors.json",
+          "xml": "%APPDATA%\\doublecmd\\doublecmd.xml"
+        }
+      },
+      ...
+    }
+    ```
+6. Profit!
+
+## :muscle: Contribution
+Contributions are greatly appreciated! If you want to report a bug or request a feature, please [open an issue](https://github.com/t0mmili/dc-themer/issues).
+
+## :heart: Sponsorship
+I create purely out of passion, in free time, on top of my day job as a Systems Engineer and a father.  
+If you find my work useful and would like to express your gratitude and support further development, [throw in some coins](https://github.com/sponsors/t0mmili) 😉
+
+##  :notebook: License
+This project is licensed under the [MIT License](https://github.com/t0mmili/dc-themer/blob/main/LICENSE).
+
+## :mag: See also
+Please also have a look at other similar projects and support authors for the great job they are doing.
+
+|||
+|---|---|
+| Double-Commander-Theme-Changer | https://github.com/delington/Double-Commander-Theme-Changer |
+| DoubleCommanderColorScheme | https://github.com/andriitishchenko/DoubleCommanderColorScheme |

docs/README.md

@@ -0,0 +1,6 @@
+# DC Themer documentation
+
+1. [Running application](running-application.md)
+2. [Tests](tests.md)
+3. [Building binary](building-binary.md)
+4. [Misc](misc.md)

docs/building-binary.md

@@ -0,0 +1,6 @@
+# Building binary
+
+## Windows
+```sh
+pyinstaller --onefile --windowed --clean --name=dc-themer --icon=./assets/dct-icon-v3.ico --add-data=./assets:assets --upx-dir='<path_to_UPX>' ./app/main.py
+```

docs/misc.md

@@ -0,0 +1,7 @@
+# Misc
+
+### Generate requirements
+```sh
+pipreqs --force ./app
+pipreqs --force ./tests
+```

docs/running-application.md

@@ -0,0 +1,11 @@
+# Running application
+
+### Install dependencies
+```sh
+pip install -r app/requirements.txt
+```
+
+### Run app
+```sh
+python -m app.main
+```

docs/tests.md

@@ -0,0 +1,13 @@
+# Tests
+
+## Unit tests
+
+### Install dependencies
+```sh
+pip install -r tests/requirements.txt
+```
+
+### Run tests
+```sh
+python tests/run_tests.py
+```