summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-12-10 16:32:07 +0200
committerThanos Apollo <[email protected]>2024-12-10 17:11:47 +0200
commitab980e81532df9386135a2a8cd65a53cc0ffe4e9 (patch)
tree86f7e65d90d8fb189790e5f037ca3018ee7e808e /doc
parent710340b5f29d1baf3ce19e1e87a1bc77a66204ad (diff)
Update docs
Diffstat (limited to 'doc')
-rw-r--r--doc/gnosis.info91
-rw-r--r--doc/gnosis.org4
-rw-r--r--doc/gnosis.texi37
3 files changed, 102 insertions, 30 deletions
diff --git a/doc/gnosis.info b/doc/gnosis.info
index 252fe79..b7afab8 100644
--- a/doc/gnosis.info
+++ b/doc/gnosis.info
@@ -3,7 +3,7 @@ gnosis.texi.
INFO-DIR-SECTION Emacs misc features
START-INFO-DIR-ENTRY
-* Gnosis (γνῶσις): (gnosis). Spaced Repetition System For Note Taking & Self-Testing.
+* Gnosis: (gnosis). Spaced Repetition Note Taking System.
END-INFO-DIR-ENTRY

@@ -17,7 +17,7 @@ enhance memory retention through active recall. It allows users to set
specific review intervals for note decks & tags, creating an optimal
learning environment tailored to each specific topic/subject.
-This manual is written for Gnosis version 0.4.2, released on 2024-09-5.
+This manual is written for Gnosis version 0.4.4, released on 2024-10-06.
• Manual:
• <https://elpa.nongnu.org/nongnu/doc/gnosis.html>
@@ -40,6 +40,7 @@ This manual is written for Gnosis version 0.4.2, released on 2024-09-5.
* Configuring Note Types::
* Sync between devices::
* Interactions with other software::
+* Contributing::
-- The Detailed Node Listing --
@@ -71,6 +72,10 @@ Interactions with other software
* emacs-no-littering::
+Contributing
+
+* How to create a patch::
+

File: gnosis.info, Node: Introduction, Next: Adding notes, Prev: Top, Up: Top
@@ -439,7 +444,7 @@ your configuration:
(gnosis-vc-pull) ;; Run vc-pull for gnosis on startup

-File: gnosis.info, Node: Interactions with other software, Prev: Sync between devices, Up: Top
+File: gnosis.info, Node: Interactions with other software, Next: Contributing, Prev: Sync between devices, Up: Top
9 Interactions with other software
**********************************
@@ -464,32 +469,66 @@ configuration:
This sets ‘gnosis-dir’ to ‘~/.emacs.d/var/gnosis’, in line with the
folders of other packages.
+
+File: gnosis.info, Node: Contributing, Prev: Interactions with other software, Up: Top
+
+10 Contributing
+***************
+
+Thank you for considering contributing back to gnosis. You can
+contribute by submitting a pull request on the codeberg mirror
+repository, or directly sending me patch via email.
+
+* Menu:
+
+* How to create a patch::
+
+
+File: gnosis.info, Node: How to create a patch, Up: Contributing
+
+10.1 How to create a patch
+==========================
+
+_Example:_
+
+ $ git clone https://git.thanosapollo.com/gnosis.git && cd gnosis
+ $ emacs something
+ $ git add something
+ $ git commit -m "Fix something"
+ $ git format-patch HEAD^1
+ 0001-Fix-something.patch
+
+ You can sent the patch to "Thanos Apollo", the email of which you can
+find on the git log.
+

Tag Table:
-Node: Top252
-Node: Introduction1674
-Node: Adding notes2687
-Node: Note Types3098
-Node: Cloze3316
-Node: MC-Cloze (Under development)4478
-Node: MCQ5466
-Node: Basic Type5904
-Node: Double6180
-Node: y-or-n6446
-Node: Customization6848
-Node: Image size7033
-Node: Typos | String Comparison7319
-Node: Gnosis Algorithm8094
-Node: Anagnosis Event8741
-Node: Proto9482
-Node: Editing notes10249
-Node: Configuring Note Types10643
-Node: Custom Note Types10855
-Node: Development12065
-Node: Sync between devices12484
-Node: Interactions with other software13569
-Node: emacs-no-littering13774
+Node: Top221
+Node: Introduction1702
+Node: Adding notes2715
+Node: Note Types3126
+Node: Cloze3344
+Node: MC-Cloze (Under development)4506
+Node: MCQ5494
+Node: Basic Type5932
+Node: Double6208
+Node: y-or-n6474
+Node: Customization6876
+Node: Image size7061
+Node: Typos | String Comparison7347
+Node: Gnosis Algorithm8122
+Node: Anagnosis Event8769
+Node: Proto9510
+Node: Editing notes10277
+Node: Configuring Note Types10671
+Node: Custom Note Types10883
+Node: Development12093
+Node: Sync between devices12512
+Node: Interactions with other software13597
+Node: emacs-no-littering13823
+Node: Contributing14323
+Node: How to create a patch14665

End Tag Table
diff --git a/doc/gnosis.org b/doc/gnosis.org
index 9fcf95d..b89401e 100644
--- a/doc/gnosis.org
+++ b/doc/gnosis.org
@@ -14,8 +14,8 @@
#+macro: kbd @@texinfo:@kbd{@@$1@@texinfo:}@@
#+texinfo_filename: gnosis.info
#+texinfo_dir_category: Emacs misc features
-#+texinfo_dir_title: Gnosis (γνῶσις): (gnosis)
-#+texinfo_dir_desc: Spaced Repetition System For Note Taking & Self-Testing
+#+texinfo_dir_title: Gnosis: (gnosis)
+#+texinfo_dir_desc: Spaced Repetition Note Taking System
#+texinfo_header: @set MAINTAINERSITE @uref{https://thanosapollo.org,maintainer webpage}
#+texinfo_header: @set MAINTAINER Thanos Apollo
#+texinfo_header: @set MAINTAINEREMAIL @email{[email protected]}
diff --git a/doc/gnosis.texi b/doc/gnosis.texi
index 4816566..a0d9a89 100644
--- a/doc/gnosis.texi
+++ b/doc/gnosis.texi
@@ -12,7 +12,7 @@
@dircategory Emacs misc features
@direntry
-* Gnosis (γνῶσις): (gnosis). Spaced Repetition System For Note Taking & Self-Testing.
+* Gnosis: (gnosis). Spaced Repetition Note Taking System.
@end direntry
@finalout
@@ -31,7 +31,7 @@ specific review intervals for note decks & tags, creating an optimal
learning environment tailored to each specific topic/subject.
@noindent
-This manual is written for Gnosis version 0.4.2, released on 2024-09-5.
+This manual is written for Gnosis version 0.4.4, released on 2024-10-06.
@itemize
@item
@@ -68,6 +68,7 @@ Git repositories:
* Configuring Note Types::
* Sync between devices::
* Interactions with other software::
+* Contributing::
@detailmenu
--- The Detailed Node Listing ---
@@ -100,6 +101,10 @@ Interactions with other software
* emacs-no-littering::
+Contributing
+
+* How to create a patch::
+
@end detailmenu
@end menu
@@ -455,4 +460,32 @@ its standards by adding the following snippet to your configuration:
This sets @samp{gnosis-dir} to @samp{~/.emacs.d/var/gnosis}, in line with the folders of other packages.
+@node Contributing
+@chapter Contributing
+
+Thank you for considering contributing back to gnosis. You can
+contribute by submitting a pull request on the codeberg mirror
+repository, or directly sending me patch via email.
+
+@menu
+* How to create a patch::
+@end menu
+
+@node How to create a patch
+@section How to create a patch
+
+@emph{Example:}
+
+@example
+$ git clone https://git.thanosapollo.com/gnosis.git && cd gnosis
+$ emacs something
+$ git add something
+$ git commit -m "Fix something"
+$ git format-patch HEAD^1
+0001-Fix-something.patch
+@end example
+
+You can sent the patch to ``Thanos Apollo'', the email of which you can
+find on the git log.
+
@bye