summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-01-10 08:40:35 +0200
committerThanos Apollo <[email protected]>2024-01-10 08:44:08 +0200
commitbb06ea04052e82efe61312cb7aaa5f03632e3209 (patch)
tree265af77e69622f05d2f66cce8c92a69b0826527f
parent1418c95f2ce6b3669bda6828e99350293e176452 (diff)
Redo README as markdown
-rw-r--r--README13
-rw-r--r--README.md31
2 files changed, 31 insertions, 13 deletions
diff --git a/README b/README
deleted file mode 100644
index f606169..0000000
--- a/README
+++ /dev/null
@@ -1,13 +0,0 @@
-
-Copyright (C) 2023 Thanos Apollo <[email protected]>
-
-================================================
- GNOSIS
-================================================
-Spaced Repetition Learning package for GNU Emacs
-------------------------------------------------
-
-
-+--------------------+
-| Under construction |
-+--------------------+ \ No newline at end of file
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)
+```