From bb06ea04052e82efe61312cb7aaa5f03632e3209 Mon Sep 17 00:00:00 2001
From: Thanos Apollo <public@thanosapollo.org>
Date: Wed, 10 Jan 2024 08:40:35 +0200
Subject: Redo README as markdown

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bacb41d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+
+# Gnosis 
+
+## About
+*Gnosis is currently under development*
+
+Gnosis is a [Spaced
+Repetition](https://en.wikipedia.org/wiki/Spaced_repetition) package
+for GNU Emacs.
+
+## Installation
+### Straight.el
+``` emacs-lisp
+(straight-use-package 
+ '(gnosis :type git
+	      :host nil
+	      :repo "https://git.thanosapollo.org/gnosis"))
+```
+
+### Manual
+``` shell
+$ git clone https://git.thanosapollo.org/gnosis
+```
+
+*Add this to your emacs configuration:*
+
+``` emacs-lisp
+   (add-to-list 'load-path "/path/to/gnosis")
+   (load-file "~/path/to/gnosis.el")
+   (require 'gnosis)
+```
-- 
cgit v1.2.3