summaryrefslogtreecommitdiff
path: root/doc/gnosis.org
diff options
context:
space:
mode:
authorThanos Apollo <[email protected]>2024-02-18 18:28:42 +0200
committerThanos Apollo <[email protected]>2024-02-18 18:28:42 +0200
commit6e89ce8852a5625214c4339dac991fd781083b9d (patch)
tree6a1d9b8ba48555b8d24cca061f7f96ab59b2882c /doc/gnosis.org
parent51d5b4661e59b6ac291aa887391689372a7e4843 (diff)
doc: Add sync devices & fix typos
Diffstat (limited to 'doc/gnosis.org')
-rw-r--r--doc/gnosis.org29
1 files changed, 23 insertions, 6 deletions
diff --git a/doc/gnosis.org b/doc/gnosis.org
index b10af7a..fe5293c 100644
--- a/doc/gnosis.org
+++ b/doc/gnosis.org
@@ -292,17 +292,34 @@ Example configuration:
(setq gnosis-algorithm-ff 0.5)
#+end_src
-** Auto push changes
+* Sync between devices
-You can interactively use =gnosis-vc-push= & =gnosis-vc-pull=.
+Gnosis uses git to maintain data integrity and facilitate
+synchronization across devices.
-As the name suggests, they rely on =vc= to work properly.
+You will need to configure your remote manually.
+
+Example:
-Make sure you have setup a git remote for gnosis.
#+begin_src bash
- cd ~/<your-emacs-directory>/gnosis # default location for gnosis
- git remote add <remote_name> <remote_url> #
+ cd ~/.emacs.d/gnosis # default location for gnosis
+ git init # After completing your first review session, a git repo should have been initialized automatically.
+ git remote add <remote_name> <remote_url>
+ git push --set-upstream origin master
#+end_src
+
+You can interactively use =gnosis-vc-push= & =gnosis-vc-pull=. As the
+name suggests, they rely on =vc= to work properly.
+
Depending on your setup, =vc= might require an external package for
the ssh passphrase dialog, such as ~x11-ssh-askpass~.
+
+
+To automatically push changes after a review session, add this to your configuration:
+#+begin_src emacs-lisp
+(setf gnosis-vc-auto-push t)
+(gnosis-vc-pull) ;; Run vc-pull for gnosis on startup
+#+end_src
+
+You might as well add