summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMohammad Abu Sakib <[email protected]>2020-04-07 22:39:52 +0600
committerGitHub <[email protected]>2020-04-07 18:39:52 +0200
commit7afe667a444504d56f8081f58324392ff8b75735 (patch)
tree7283537437979d4e6a7f77a84dd17d635c73f743 /README.md
parentb73dd77b847c692e9718d798b021c2cf552bd66e (diff)
downloadatril-7afe667a444504d56f8081f58324392ff8b75735.tar.bz2
atril-7afe667a444504d56f8081f58324392ff8b75735.tar.xz
Migrate to README.md and fix links
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b28fde2b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Atril
+==================================================
+Atril is a simple multi-page document viewer. It can display and print PostScript (PS), Encapsulated PostScript (EPS), DJVU, DVI, XPS and Portable Document Format (PDF) files. When supported by the document, it also allows searching for text, copying text to the clipboard, hypertext navigation, and table-of-contents bookmarks. Atril is a fork of Evince.
+
+This software is licensed under the GNU GPL. For more on the license, see COPYING.
+
+Atril Requirements
+==================================================
+* [MATE Platform libraries](https://github.com/mate-desktop/mate-desktop/)
+
+* [Poppler](https://poppler.freedesktop.org/) for PDF viewing
+
+* [GhostScript](https://www.ghostscript.com/) for PostScript viewing
+
+Atril Optional Backend Libraries
+==================================================
+* [DjVuLibre](http://djvu.sourceforge.net/) for DjVu viewing
+
+* [RAR](https://www.rarlab.com/) for viewing CBR comics
+
+* [libgxps](https://wiki.gnome.org/Projects/libgxps) for XPS documents
+
+Atril Requirements to Run Tests
+==================================================
+* [python-dogtail](https://gitlab.com/dogtail/dogtail)
+* [python-pyatspi2](https://download.gnome.org/sources/pyatspi/)