aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Wimpress <code@flexion.org>2019-06-04 11:54:19 +0100
committerMartin Wimpress <code@flexion.org>2019-06-04 11:54:19 +0100
commitc691b8eec468c815df2e18ca54cee07e76e99fdc (patch)
treea5f4357d8304657cd74e6c230016d439b48386b2
parentAdd logo. (diff)
downloadmagnus-c691b8eec468c815df2e18ca54cee07e76e99fdc.tar.gz
magnus-c691b8eec468c815df2e18ca54cee07e76e99fdc.tar.bz2
magnus-c691b8eec468c815df2e18ca54cee07e76e99fdc.zip
readme: Add logo and more detailed build instructions.
-rw-r--r--README.md27
1 files changed, 23 insertions, 4 deletions
diff --git a/README.md b/README.md
index 8226546..f957a5a 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,16 @@
-# Magnus
+<h1 align="center">
+ <img src="data/logo.png" alt="Magnus">
+ <br />
+ Magnus
+</h1>
-A very simple screen magnifier app for Ubuntu.
+<p align="center"><b>A very simple screen magnifier.</b></p>
![Magnus Screenshot](data/screenshot.png?raw=true)
-## Install
+<p align="center">Made with 💝 for <img src="https://raw.githubusercontent.com/anythingcodes/slack-emoji-for-techies/gh-pages/emoji/tux.png" align="top" width="24" /></p>
+
+## Building, Testing, and Installation
### Ubuntu
@@ -16,4 +22,17 @@ A [PPA for Magnus](https://launchpad.net/~flexiondotorg/+archive/ubuntu/magnus)
### Source
- sudo python3 setup.py install
+You'll need the following dependencies:
+
+ * gir1.2-gdkpixbuf-2.0
+ * gir1.2-glib-2.0
+ * gir1.2-gtk-3.0
+ * python3
+ * python3-gi
+ * python3-setproctitle
+
+Run `setup.py` to build and install Magnus:
+
+```bash
+sudo python3 setup.py install
+```
bgstack15