From b078c447e247a0c66c38ae003fcfae372c522360 Mon Sep 17 00:00:00 2001 From: Philip Goto Date: Tue, 11 Jul 2017 00:03:10 +0200 Subject: [PATCH] edit readmes --- CONTRIBUTING.md | 13 +++++++++---- README.md | 17 +---------------- 2 files changed, 10 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18228e9..a0c4217 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,11 @@ -# Create an issue -Please create a seperate issue for each icon. When creating an issue about an icon (like icon requests), please add the filename of the icon. +# Creating an issue -For apps, you can find this information in the .desktop file of the app (in /usr/share/applications/ or ~/.local/share/applications/) under `Icon`. +## Icon requests +Please create a seperate issue for each icon, or use checkboxes in your issue. -For mimetypes, this is the mimetype itself in the properties of the file. +Please also add the filename of the icon. + - For apps, you can find this information in the .desktop file of the app (in /usr/share/applications/ or ~/.local/share/applications/) under `Icon`. + - For mimetypes, this is the mimetype itself in the properties of the file. + +## Bug reports +When you encounter a problem with Mato, or one that you think is caused by it, please submit a bug report. When doing this, make sure you describe your problem as cearly as possible. Try to include screenshots or steps to reproduce your problem. diff --git a/README.md b/README.md index 4aa8bf5..afd2f25 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,5 @@ # Mato -![Screenshot](http://i.imgur.com/uykTYWO.png) - -*Screenshot: Mato icons on [GNOME](https://www.gnome.org/) desktop with [Flat-Plat](https://github.com/nana-4/Flat-Plat) theme* - -Mato is a Material Design inspired icon theme for Linux. It features simple and modern icons based on the official icons. Although this icon theme is based on the Material Design Guidelines, I don't follow them 100%. - -*Mato is currently in development, many icons are missing or will be changed.* - -## Install -If you're using Arch Linux you can install Mato using the AUR package `mato-icons-git`. -Otherwise, you can install and update Mato by executing the following command in your terminal. -```bash -sh -c 'cd /tmp; rm -rf Mato/; git clone https://github.com/flipflop97/Mato.git; Mato/install.sh' -``` - -*I'm working on getting packages ready for other distros, they will be available soon™.* +For general information and previews, visit [flipflop97.github.io/Mato](https://flipflop97.github.io/Mato/). ## Request icons If you want to request an icon, create an issue for it. Please read [the guidelines](CONTRIBUTING.md) before doing so.