summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README62
l---------README.md1
2 files changed, 57 insertions, 6 deletions
diff --git a/README b/README
index d269e934..85275dff 100644
--- a/README
+++ b/README
@@ -1,14 +1,64 @@
-This is Caja, the file manager for the MATE desktop.
+[![Build Status](https://travis-ci.org/mate-desktop/caja.svg?branch=master)](https://travis-ci.org/mate-desktop/caja)
+[![Release](https://img.shields.io/github/v/release/mate-desktop/caja)](https://github.com/mate-desktop/caja/releases)
+[![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg "IRC Freenode")](https://webchat.freenode.net/?channels=mate)
-Caja is a fork of Nautilus.
+<h1 align="center">
+ <img src="https://github.com/mate-desktop/mate-icon-theme/raw/master/mate/256x256/apps/system-file-manager.png" alt="Caja" width="128" height="128">
+ <br />
+ Caja
+</h1>
-Hacking on Caja
-===================
+<p align="center"><b>The file manager for the MATE desktop</b></p>
+<div align="center"><img src="https://mate-desktop.org/gallery/1.24/english/007.png" alt="Caja Screenshot"></div>
+
+## Installation
+
+### Ubuntu
+
+```bash
+sudo apt install caja
+```
+
+### Fedora
+
+```bash
+sudo dnf install caja
+```
+
+## Building
+
+### Source
+
+You'll need the following dependencies:
+
+ * `exempi`
+ * `gobject-introspection`
+ * `libnotify`
+ * `libexif`
+ * `gvfs`
+ * `mate-common`
+ * `mate-desktop`
+
+### Building
+
+```bash
+git clone --recurse-submodules https://github.com/mate-desktop/caja.git
+cd caja
+./autogen.sh --prefix=/usr
+make
+make install
+```
+
+## Hacking on Caja
Please see the HACKING file for information about hacking on caja.
-How to report bugs
-==================
+## How to report bugs
Bugs should be reported in GitHub
+
https://github.com/mate-desktop/caja/issues
+
+## Package status
+
+[![Packaging status](https://repology.org/badge/vertical-allrepos/caja.svg)](https://repology.org/project/caja/versions)
diff --git a/README.md b/README.md
new file mode 120000
index 00000000..100b9382
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+README \ No newline at end of file