From 8f2f466965f061ce6d6be4443497c0fe6e10a5bc Mon Sep 17 00:00:00 2001
From: azahi <azahi@teknik.io>
Date: Fri, 28 Dec 2018 01:22:40 +0300
Subject: Initial

---
 README.rst | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.rst

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..b481a06
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,42 @@
+========
+ricerlay
+========
+
+-------
+Purpose
+-------
+
+The main Gentoo package tree doesn't have some crucial packages for ricing.
+Some of them do exist but live ebuilds are not present or broken.
+This overlay is aimed to fix these issues and promote Gentoo as a favorable distribution for the those who want to customize their desktop.
+
+------------
+Installation
+------------
+
+::
+
+   layman -a ricerlay
+   layman -S
+   emerge <package>
+
+----------------
+Getting Involved
+----------------
+
+Please do contribute!
+
+If you are willing to help there is a TODO list that contains packages needed to be added or updated.
+However, you are not limited to only working with it. You are encouraged to add interesting packages related to ricing, customization and workflow improvement.
+
+Example workflow could look like this:
+
+::
+
+   ### Fork this repository
+   git clone https://github.com/<your github username>/ricerlay.git
+   ### Make changes
+   git add <your changes>
+   git commit -m "<category>/<package>: <briefly state your changes>"
+   git push -f origin master
+   ### Create a PR via GitHub's web interface or using your prefered integration tool
-- 
cgit 1.4.1