From bb06ea04052e82efe61312cb7aaa5f03632e3209 Mon Sep 17 00:00:00 2001 From: Thanos Apollo Date: Wed, 10 Jan 2024 08:40:35 +0200 Subject: Redo README as markdown --- README | 13 ------------- README.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 13 deletions(-) delete mode 100644 README create mode 100644 README.md 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 - -================================================ - 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) +``` -- cgit v1.2.3