Merge pull request #30 from gusbemacbe/beta

Final Release 2.0

AUTHORS

@@ -27,3 +27,7 @@ URL: https://github.com/gusbemacbe/suru-plus
 
 - Gustavo Costa <gusbemacbe@gmail.com>
 
+* Contributors:
+
+- Chris Escarra <@ChrisP4>
+

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing
+
+We are open for new issues and pull requests. By participating in this project, you agree to abide by our [Licence][licence].
+
+If you'd like to contribute and don't understand something here, reach out on our issue, and we will be happy to offer solutions. Additionally, we welcome any attempts to engage with the project - through acquiring the source code, following documentation steps to get started, and then offering feedback in our communications channels on how this process could be improved.
+
+Design and setup steps are covered in the [README][dev setup].
+
+[licence]: https://github.com/gusbemacbe/suru-plus/blob/master/LICENSE
+
+## Steps
+
+### Fork and Clone
+
+Fork our repository and create a clone to your personal system.
+
+### Branches
+
+After forking our repository, create one branch per bugs or per files or per icons on your personal repository.
+
+The branch name should describe the bug or version ("alpha or "beta" or "new-icons"). It should start with the bug or version number, and include a very short description of the bug, or a short version of the bug's title.
+
+## Developing
+
+* You must use the app [Gravit Designer](https://gravit.io) to build the new icons.
+* Please use our icon template [Suru++ 20 Icon Template](https://github.com/gusbemacbe/suru-plus/blob/beta/templates/Suru%2B%2B%2020%20Template.gvdesign), opening it with Gravit Designer. Export to SVG. 
+* Also make two monochromatic and small icons: 
+  * one for the folder `16`
+  * another for the `symbolic` with the suffix `-symbolic`. 
+  * Export both to SVG.
+* It is important that not all the features of an icon are supported in the KDE environment. Here are the unsupported features:
+  * Blur
+  * Drop shadow blur (use the natural drop shadow in Gravit Designer)
+  * Inner shadow blur (use the natural inner shadow in Gravit Designer)
+  * Masks (instead, cut with intersection or vectorise all the objects)
+* You must follow the rules of colours and grids of Sam Hewitt's [Suru Design Guideline](https://snwh.org/suru/guidelines). 
+  * **Colours:** As for Suru++20, prefer the vivid colours of Suru plaette
+  * **Grids:** A symbol must be resized to 145px and if it is a symbol in form of circle grid, use 165px. 
+* We also provide a Suru colours palette. Here is the [Suru Palette](https://github.com/gusbemacbe/suru-plus/blob/beta/templates/Suru%20Palette.gvswatch).
+* As for the gradients, we prepare a list of gradients for you: [Suru++ Gradients Palette](https://github.com/gusbemacbe/suru-plus/blob/beta/templates/Suru%2B%2B%20Gradients%20Palette.gvswatch).
+
+### Commit messages
+
+Commit messages should generally follow [this helpful advice](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), but please start your commit message with:
+* "Added [name of icon] icon" if it is only an icon
+* "Added [number of icons] icons" if it is more than icons
+* "Fixes #nn:" if it is a bug
+* "Improved ##nn" if it is an improvement of a file or an icon
+
+It eases skimming history later. For this reason, the first line will tend to be longer than the 50 chars suggested in that article, aim to keep it less than 72 chars.
+
+### Submitting the pull request
+
+When you submit a pull request, please use the description field to explain in words the overall intention of your changes. A few sentences should be plenty. It's also ok to reuse the commit message, if you included a lot of discussion there.
+
+At this point you're waiting on us. We like to at least comment on pull requests within among one and three days. We may suggest some changes or improvements or alternatives.
+
+### Reviews
+
+We try to avoid landing anything without at least a cursory review. We firstly may analyse your codes, your icons or anything else if they must improve. 
+
+### Merging
+
+When a pull request has passed review, the reviewer generally merges.
+

COPYING

@@ -16,13 +16,19 @@ Copyright (c) 2018 Alexey Varfolomeev <https://github.com/varlesh>
 
 GNU General Public License v3.0
 
-Permissions of this strong copyleft license are conditioned on making available complete 
-source code of licensed works and modifications, which include larger works 
-using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.
+Permissions of this strong copyleft license are conditioned on making available 
+complete  source code of licensed works and modifications, which include 
+larger works  using a licensed work, under the same license. Copyright and 
+license notices must be preserved. Contributors provide an express 
+grant of patent rights.
 
 Copyright (c) 2014-2018 Numix Project
 
 GNU General Public License v3.0
 
-Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.
+Permissions of this strong copyleft license are conditioned on making available 
+complete  source code of licensed works and modifications, which include 
+larger works  using a licensed work, under the same license. Copyright and 
+license notices must be preserved. Contributors provide an express 
+grant of patent rights.
 

CREDITS

@@ -0,0 +1,24 @@
+# Credits
+
+Suru++ 20
+URL: https://github.com/gusbemacbe/suru-plus
+
+* The FreeDesktop Suru icon set is designed and developed by:
+- Sam Hewitt <sam@snwh.org>
+
+* The original Suru icon set and concept was created by:
+- Matthieu James
+- Canonical Design Team
+
+* Emoji icons are derived from the Twenoji created by:
+- Twitter Team
+
+* Mimetype icons are based on Numix mimetypes icons created by:
+- Numix Team
+
+* Places icons are inspired by Papirus places icons created by:
+- Alexey Varfolomeev <https://github.com/varlesh>
+
+* Suru++ 20 is based on Suru++ Ubuntu:
+- Andrea Bonanni (original author) <bonandry@gmail.com>
+

README.md

@@ -20,7 +20,7 @@
 - [Contribution](#contribution)
 - [Contributors](#contributors)
 - [Changelog](#changelog)
-- [Credits and Licence](#credits-and-licence)
+- [Credits and Licences](#credits-and-licences)
 
 ## What’s new in the new version 20?
 
@@ -36,6 +36,20 @@
 
 ![Screenshot](images/preview3.png)
 
+* You can choose one of three alternatives of Firefox:
+
+| ![](images/firefox-traditional.png) | ![](images/firefox.png) | ![](images/firefox-mozilla.png) |
+| :---------------------------------: | :---------------------: | :-----------------------------: |
+| Traditional                         | Suru++ 20               | Mozilla Unofficial              |
+| `firefox-traditional.svg`           | `firefox.svg`           | `firefox-mozilla.svg`           |
+
+**How to change the alternative of these?**
+
+1. Go to `/usr/share/applications/`;
+2. Go to the desktop file `Firefox`;
+3. Open the file with your favourite text editor;
+4. Find `Icon=...` and modify it with one of three alternatives: `Icon=firefox` or `Icon=firefox-mozilla` or `Icon=firefox-traditional`. Save it.
+
 ## Installing with CLI
 
 It is too easy and quick to install. I recommend strongly the SVN. Firstly you must install both packages `git` and `subversion`.
@@ -100,12 +114,12 @@ The contributors is on the file [AUTHORS](AUTHORS).
 
 The changelog is available on the release page in theme's repository.
 
-## Credits and Licence
+## Credits and Licences
 
-* CC-BYSA/GPL3 © 2018 Suru by Sam Hewitt.
-* GPL3 © 2018 Suru++ [Minimal] by Andrea Bonanni and Gustavo Costa. 
+* CC BY-SA/GPL3 © 2018 Suru Icons by Sam Hewitt.
+* GPL3 © 2018 Suru++ Ubuntu by Andrea Bonanni and Gustavo Costa. 
 * GPL3 © 2018 Suru++ 20 by Gustavo Costa.
 * GPL3 © Papirus by Alexey Varfolomeev.
 * GPL3 © Numix by Numix Team.
 * MIT © Twemoji by Twitter Team.
-* CC-BYSA © Some Icons by Flaticon. 
+* CC BY-SA © Some Icons by Flaticon. 

apps/16/com.github.parnold-x.nasc.svg

@@ -0,0 +1 @@
+nasc.svg

apps/16/com.googleplaymusicdesktopplayer.GPMDP.svg

@@ -0,0 +1 @@
+google-play-music-desktop-player.svg

apps/16/com.googleplaymusicdesktopplayer.svg

@@ -0,0 +1 @@
+google-play-music-desktop-player.svg

apps/16/firefox-traditional.svg

@@ -0,0 +1 @@
+firefox.svg

apps/16/glass/spacefm-find.svg

@@ -0,0 +1 @@
+glass.svg

apps/scalable/com.github.parnold-x.nasc.svg

@@ -0,0 +1 @@
+nasc.svg

apps/scalable/com.googleplaymusicdesktopplayer.GPMDP.svg

@@ -0,0 +1 @@
+google-play-music-desktop-player.svg

apps/scalable/com.googleplaymusicdesktopplayer.svg

@@ -0,0 +1 @@
+google-play-music-desktop-player.svg