From 3c98f92491a0ac81a95af49038665099423661ab Mon Sep 17 00:00:00 2001
From: Thanos Apollo <public@thanosapollo.org>
Date: Fri, 9 Feb 2024 15:58:50 +0200
Subject: Add CONTRIBUTING.org

---
 CONTRIBUTING.org | 33 +++++++++++++++++++++++++++++++++
 README           |  9 +++++++++
 README           |  9 ---------
 3 files changed, 42 insertions(+), 9 deletions(-)
 create mode 100644 CONTRIBUTING.org
 create mode 100644 README
 delete mode 100644 README 

diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
new file mode 100644
index 0000000..4cf194f
--- /dev/null
+++ b/CONTRIBUTING.org
@@ -0,0 +1,33 @@
+#+title: Contributing | Gnosis
+#+author: Thanos Apollo
+
+
+* Sources
++ [[https://git.thanosapollo.org/gnosis][Upstream]]
+
+* How To Contribute
+Before starting to work on any big feature, that is not mentioned on
+the [[Task List][Task List]], I recommend you to send me an email first.
+
+** How to submit a PR?
+Feel free to send me a patch, here's how to create one:
+
+#+begin_src bash
+$ git clone https://git.thanosapollo.com/<repo>.git && cd <repo>
+$ emacs something
+$ git add something
+$ git commit -m "Fix something"
+$ git format-patch HEAD^1
+0001-Fix-something.patch
+#+end_src
+
+/You can find my email on the git log/
+
+
+* Tasks
+** TODO Add Dashboard
++ Create a dashboard to view all notes created, user can edit &
+  suspend notes. Use tabulated-list-mode, preferably.
+
+** TODO Algorithm: changes for ef increase/decrease factors
++ After 3 successful in a row reviews increase ef increase factor by 5% & vice versa
diff --git a/README b/README
new file mode 100644
index 0000000..34e8089
--- /dev/null
+++ b/README
@@ -0,0 +1,9 @@
+
+Gnosis (γνῶσις)
+====
+
+Gnosis (γνῶσις), pronounced "noh-sis", meaning knowledge in Greek,
+is a Spaced Repetition System for note taking and self testing.
+
+- Project's Page:             <https://thanosapollo.org/projects/gnosis/>
+- User Manual:                <https://thanosapollo.org/user-manual/gnosis/>
diff --git a/README  b/README 
deleted file mode 100644
index 865430c..0000000
--- a/README 	
+++ /dev/null
@@ -1,9 +0,0 @@
-
-Gnosis (γνῶσις)
-====
-
-Gnosis (γνῶσις), pronounced "noh-sis", *meaning knowledge in Greek*,
-is a Spaced Repetition System for note taking and self testing.
-
-- Project's Page:             <https://thanosapollo.org/projects/gnosis/>
-- User Manual:                <https://thanosapollo.org/user-manual/gnosis/>
-- 
cgit v1.2.3