about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorSören Tempel <soeren+git@soeren-tempel.net>2021-05-16 22:24:33 +0200
committerSören Tempel <soeren+git@soeren-tempel.net>2021-05-16 22:24:33 +0200
commitd71f702779acbb08b9d96811999043f36e37e580 (patch)
treec4084b60679b9211490b1acc2ef1cce108ce3aea /README.md
parent1047afa31e415d2ccc59af169e0bbe3175a708d3 (diff)
README.md: Add text to installation section
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6f8b9f4..c4eb59c 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,17 @@ To-Do.
 
 ## Installation
 
-To-Do.
+This software has the following dependencies:
+
+* [python3][python web]
+* [PyGObject][PyGObject web] and [gtk+3.0][gtk web]
+* [setuptools][setuptools web]
+
+If these are installed run the following command to install `saneterm`:
+
+	$ python3 setup.py install --optimize=1
+
+For development setups just run `python3 saneterm/__main__.py`.
 
 ## FAQ
 
@@ -28,3 +38,8 @@ Public License for more details.
 
 You should have received a copy of the GNU General Public License along
 with this program. If not, see <http://www.gnu.org/licenses/>.
+
+[python web]: https://www.python.org/
+[PyGObject web]: https://pygobject.readthedocs.io/en/latest/
+[gtk web]: https://gtk.org/
+[setuptools web]: https://pygobject.readthedocs.io/en/latest/