Merge pull request #5 from Brambleberry4/master

Docs updated
gnome-terminator · Jun 3, 2021 · 9041ce3 · 9041ce3
2 parents 07683b4 + fcacd3c
commit 9041ce3
Show file tree

Hide file tree

Showing 7 changed files with 116 additions and 85 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -2,5 +2,5 @@ Authors
 -------
 
 * Steve Boddy
-
+* Felix Mölder, Bramblebery4 (02/2021)
 
diff --git a/README.rst b/README.rst
@@ -1,4 +1,4 @@
-Terminator Manual (GTK2)
+Terminator Manual (GTK3)
 ========================
 
 Fully fleshed-out manual for Terminator.
@@ -10,13 +10,23 @@ This Manual and included images are wholly new pieces created by the current mai
 How to Build
 ------------
 
-* Install the shinx package and the ReadTheDocs theme `pip install sphinx sphinx-rtd-theme` 
+* Install the shinx package and the ReadTheDocs theme ``pip3 install sphinx sphinx-rtd-theme`` 
 * Clone this repository
-* ``cd docs``
-* Build the HTML pages ``make html``
+* ``cd docs/source``
+* Build the HTML pages: ``make html``
+
+For Python2.X:
+~~~~~~~~~~~~~~
+
 * serve up the web pages: ``cd _build/html && python -m SimpleHTTPServer 4000``
 * Review the results at http://localhost:4000
 
+For Python3.X:
+~~~~~~~~~~~~~~
+
+* serve up the web pages: ``cd _build/html && python3 -m http.server 4000``
+* Review the results in your browser at http://localhost:4000
+
 Imported from Launchpad: https://code.launchpad.net/~gnome-terminator/terminator/manual-gtk3
 
 .. _CC-BY-SA: http://creativecommons.org/licenses/by-sa/4.0/

diff --git a/source/gettingstarted.rst b/source/gettingstarted.rst
diff --git a/source/history.rst b/source/history.rst
@@ -34,12 +34,21 @@ All contributions and improvements are welcome.
 +--------------+------------+-----------------+------------------------------------+
 | 1.91, r1759  | 2017-03-29 | Stephen Boddy   | Updates for the GTK3 Port     |br| |
 +--------------+------------+-----------------+------------------------------------+
-| 1.92         | 2017-??-?? | Stephen Boddy   | Updates for 1.92 release      |br| |
+| 1.92         | 2017-04-18 | Markus Frosch   | Updates for 1.92 release      |br| |
 +--------------+------------+-----------------+------------------------------------+
-| 2.0          | 2017-??-?? | Stephen Boddy   | Updates for 2.0 release       |br| |
+| 2.0          | 2020-10-06 | Matt Rose       | Updates for 2.0 release       |br| |
++--------------+------------+-----------------+------------------------------------+
+| 2.0.1        | 2020-10-11 | Matt Rose       | Minor bugfix release          |br| |
++--------------+------------+-----------------+------------------------------------+
+| 2.1          | 2021-01-04 | Matt Rose       | Updates for 2.1 release       |br| |
 +--------------+------------+-----------------+------------------------------------+
 
+For a more detailed overview and changelogs see `release notes`_ and `changelogs`_.
+
 .. note:: Ideally this documentation should be kept up-to-date with
           the changes as they go in. This way things don't get missed.
           There could be some lag between releases, but it should
           definitely be updated for a new release.
+
+.. _changelogs: https://github.com/gnome-terminator/terminator/blob/master/CHANGELOG.md
+.. _release notes: https://github.com/gnome-terminator/terminator/releases/
diff --git a/source/index.rst b/source/index.rst
@@ -10,14 +10,14 @@ Sometimes it is not always
 clear just how many little shortcuts and features there are in Terminator. This
 manual hopes to reduce the confusion.
 
-A quick word on style. I have none. 😃 I have  casual way of talking and writing,
-and a strange sense of humour. I also tend to use random pop-culture references
-a lot, but often in ways that make no sense. If this is a problem you are
-entitled to a refund of the money you paid to me to write this... 😎
+.. A quick word on style. I have none. 😃 I have  casual way of talking and writing,
+.. and a strange sense of humour. I also tend to use random pop-culture references
+.. a lot, but often in ways that make no sense. If this is a problem you are
+.. entitled to a refund of the money you paid to me to write this... 😎
 
-------------------
-What is Terminator
-------------------
+-------------------
+What is Terminator?
+-------------------
 
 At its simplest Terminator is a terminal emulator like xterm, gnome-terminal,
 konsole, etc. At its most complex it lets you fly... metaphorically at least.
@@ -35,6 +35,7 @@ Take a look at the following list:
 - Save multiple layouts and profiles via GUI preferences editor
 - Simultaneous typing to arbitrary groups of terminals
 - Extensible through plugins
+- Dynamic and customizable layouts
 
 and lots more...
 

diff --git a/source/licensing.rst b/source/licensing.rst
@@ -29,7 +29,8 @@ provided under the `CC-BY-SA licence`_.
 This **Manual** and **API documentation** are wholly new pieces
 created by the current maintainer *Steve Boddy*, and are distributed
 under the `CC-BY-SA licence`_, as are the horrific attempts by yours
-truly at using Cory's icon to provide page identities.
+truly at using Cory's icon to provide page identities. It is updated
+by *Felix Mölder* and also published under the `CC-BY-SA licence`_.
 
 The **Documentation Theme**  is the `Read The Docs`_ theme by *Dave
 Snider*, which is distributed under the `MIT licence`_. The theme is

diff --git a/source/preferences.rst b/source/preferences.rst
@@ -744,6 +744,5 @@ About
 
 A simple panel describing a bit about the application, and a set of
 links that will guide users to some helpful Terminator project
-resources. There's also a mysterious button... I wonder what happens
-when I press it?...
+resources.