Merge pull request #394 from facelessuser/maintenance/update-docs

Update documentation
facelessuser · Jul 1, 2020 · e6a6609 · e6a6609
2 parents 47a65c6 + 74149b9
commit e6a6609
Show file tree

Hide file tree

Showing 25 changed files with 959 additions and 476 deletions.
diff --git a/README.md b/README.md
@@ -10,13 +10,13 @@
 Rummage is a cross platform search and replace tool. Rummage crawls directories and searches for specified patterns
 (either regular expression or literal) and can optionally replace those targets with desired text.
 
-Rummage is written in Python and is currently available on Python 3.4+ (some older releases are available for Python
-2.7). Rummage by default uses Python's Re regular expression engine, but you can also use the fantastic, feature rich
-[Regex](https://pypi.python.org/pypi/regex) search engine and do interesting things like fuzzy searching and more.
+Rummage is written in Python and is currently available on Python 3. Rummage by default uses Python's Re regular
+expression engine, but you can also use the fantastic, feature rich [Regex](https://pypi.python.org/pypi/regex) search
+engine and do interesting things like fuzzy searching and more.
 
 ## Screenshots
 
-![Rummage Search](https://github.com/facelessuser/Rummage/raw/master/docs/src/markdown/images/search_tab.png)
+![Rummage Search](https://github.com/facelessuser/Rummage/raw/master/docs/src/markdown/images/preview.png)
 
 ![Rummage Files](https://github.com/facelessuser/Rummage/raw/master/docs/src/markdown/images/files_tab.png)
 

diff --git a/docs/src/dictionary/en-custom.txt b/docs/src/dictionary/en-custom.txt
@@ -150,6 +150,7 @@ timestamp
 tooltip
 tuple
 un
+uncheck
 unhandled
 useable
 validator

diff --git a/docs/src/markdown/about/changelog.md b/docs/src/markdown/about/changelog.md
diff --git a/docs/src/markdown/about/contributing.md b/docs/src/markdown/about/contributing.md
@@ -11,35 +11,48 @@ Contribution from the community is encouraged and can be done in a variety of wa
 
 ## Bug Reports
 
-1. Please **read the documentation** and **search the issue tracker** to try to find the answer to your question **before** posting an issue.
+1. Please **read the documentation** and **search the issue tracker** to try to find the answer to your question
+  **before** posting an issue.
 
 2. When creating an issue on the repository, please provide as much info as possible:
 
     - Version being used.
     - Operating system.
     - Errors in console.
     - Detailed description of the problem.
-    - Examples for reproducing the error.  You can post pictures, but if specific text or code is required to reproduce the issue, please provide the text in a plain text format for easy copy/paste.
+    - Examples for reproducing the error.  You can post pictures, but if specific text or code is required to reproduce
+      the issue, please provide the text in a plain text format for easy copy/paste.
 
     The more info provided the greater the chance someone will take the time to answer, implement, or fix the issue.
 
-3. Be prepared to answer questions and provide additional information if required.  Issues in which the creator refuses to respond to follow up questions will be marked as stale and closed.
+3. Be prepared to answer questions and provide additional information if required.  Issues in which the creator refuses
+   to respond to follow up questions will be marked as stale and closed.
 
 ## Reviewing Code
 
-Take part in reviewing pull requests and/or reviewing direct commits.  Make suggestions to improve the code and discuss solutions to overcome weaknesses in the algorithm.
+Take part in reviewing pull requests and/or reviewing direct commits.  Make suggestions to improve the code and discuss
+solutions to overcome weaknesses in the algorithm.
 
 ## Pull Requests
 
-Pull requests are welcome, and if you plan on contributing directly to the code, there are a couple of things to be mindful of.
+Pull requests are welcome, and if you plan on contributing directly to the code, there are a couple of things to be
+mindful of.
 
-Continuous integration tests are run on all pull requests and commits via Travis CI.  When making a pull request, the tests will automatically be run, and the request must pass to be accepted.  You can (and should) run these tests before pull requesting. You should also add tests for bugs you are fixing. If it is not possible to run these tests locally, they will be run when the pull request is made, but it is strongly suggested that requesters make an effort to verify before requesting to allow for a quick, smooth merge.
+Continuous integration tests are run on all pull requests and commits via Travis CI.  When making a pull request, the
+tests will automatically be run, and the request must pass to be accepted.  You can (and should) run these tests before
+pull requesting. You should also add tests for bugs you are fixing. If it is not possible to run these tests locally,
+they will be run when the pull request is made, but it is strongly suggested that requesters make an effort to verify
+before requesting to allow for a quick, smooth merge.
 
 ### GUI Tools
 
-The GUI is designed with the tool [`wxFormBuilder`](https://github.com/wxFormBuilder/wxFormBuilder).  Usually the latest version is used unless there are some problematic issues. Simply open the `gui.fbp` file with `wxFormBuilder`. The gear icon in the toolbar will generate the Python code.
+The GUI is designed with the tool [`wxFormBuilder`](https://github.com/wxFormBuilder/wxFormBuilder).  Usually the latest
+version is used unless there are some problematic issues. Simply open the `gui.fbp` file with `wxFormBuilder`. The gear
+icon in the toolbar will generate the Python code.
 
-Current version being used is **3.8.1**.
+Current version being used is **3.9.0**.
+
+Currently `tools/gui_patch.py` should be run on the output before running Rummage.
 
 ### Running Validation Tests
 
@@ -55,14 +68,23 @@ Current version being used is **3.8.1**.
     tox
     ```
 
-    Tox should install necessary dependencies and run the tests. If you are a Linux user, please check out information on [requirements](../installation.md#requirements).
+    Tox should install necessary dependencies and run the tests. If you are a Linux user, please check out information
+    on [requirements](../installation.md#requirements).
 
 ## Documentation Improvements
 
-A ton of time has been spent not only creating and supporting this plugin, but also spent making this documentation.  If you feel it is still lacking, show your appreciation for the plugin by helping to improve the documentation.  Help with documentation is always appreciated and can be done via pull requests.  There shouldn't be any need to run validation tests if only updating documentation.
+A ton of time has been spent not only creating and supporting this plugin, but also spent making this documentation.
+If you feel it is still lacking, show your appreciation for the plugin by helping to improve the documentation.  Help
+with documentation is always appreciated and can be done via pull requests.  There shouldn't be any need to run
+validation tests if only updating documentation.
 
-To build the documentation, you will need the necessary requirements. You can get them by running `pip install -r requirements/docs.txt`. I currently use a combination of [MkDocs][mkdocs], the [Material theme][mkdocs-material], and [PyMdown Extensions][pymdown-extensions] to render the docs.  You can preview the docs if you install these packages via the requirements file.  The command for previewing the docs is `mkdocs serve`. It should be run from the root directory. You can then view the documents at `localhost:8000`.
+To build the documentation, you will need the necessary requirements. You can get them by running
+`pip install -r requirements/docs.txt`. We currently use a combination of [MkDocs][mkdocs], the
+[Material theme][mkdocs-material], and [PyMdown Extensions][pymdown-extensions] to render the docs.  You can preview
+the docs if you install these packages via the requirements file.  The command for previewing the docs is
+`mkdocs serve`. It should be run from the root directory. You can then view the documents at `localhost:8000`.
 
-When providing documentation updates, please generate Rummage's internal documentation via `python tools/gen_docs.py`. Pull requests will currently fail if the documentation is not updated along with the requested changes.
+When providing documentation updates, please generate Rummage's internal documentation via `python tools/gen_docs.py`.
+Pull requests will currently fail if the documentation is not updated along with the requested changes.
 
 --8<-- "links.txt"
diff --git a/docs/src/markdown/about/license.md b/docs/src/markdown/about/license.md
@@ -4,14 +4,23 @@ MIT license.
 
 Copyright (c) 2013 - 2020 Isaac Muse <[email protected]>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ---
 
-Internal documentation includes use of [Font Awesome 4.7 by Dave Gandy](https://fontawesome.com/v4.7.0/). Only a subset of the icons are actually distributed with Rummage. The subset of icons was generated by [Fontello](http://fontello.com/).
+Internal documentation includes use of [Font Awesome 4.7 by Dave Gandy](https://fontawesome.com/v4.7.0/). Only a subset
+of the icons are actually distributed with Rummage. The subset of icons was generated by using
+[Fontello](http://fontello.com/).
 
 The Font Awesome font is licensed under the [SIL OFL 1.1](http://scripts.sil.org/OFL)
diff --git a/docs/src/markdown/images/preview.png b/docs/src/markdown/images/preview.png
diff --git a/docs/src/markdown/images/settings_search.png b/docs/src/markdown/images/settings_search.png
diff --git a/docs/src/markdown/index.md b/docs/src/markdown/index.md
@@ -2,11 +2,14 @@
 
 ## Overview
 
-Rummage is a cross platform search and replace tool. Rummage crawls directories and searches for specified patterns (either regular expression or literal) and can optionally replace those targets with desired text.
+Rummage is a cross platform search and replace tool. Rummage crawls directories and searches for specified patterns
+(either regular expression or literal) and can optionally replace those targets with desired text.
 
-Rummage is written in Python and is currently available on Python 3.4+ (some older releases are available for Python 2.7). Rummage by default uses Python's Re regular expression engine, but you can also use the fantastic, feature rich [Regex][regex] search engine and do interesting things like fuzzy searching and more.
+Rummage is written in Python and is currently available on Python 3. Rummage by default uses Python's Re regular
+expression engine, but you can also use the fantastic, feature rich [Regex][regex] search engine and do interesting
+things like fuzzy searching and more.
 
-![Search Tab](images/search_tab.png)
+![Search Tab](images/preview.png)
 
 ![Files Tab](images/files_tab.png)