search

l3kn / org-fc

Spaced Repetition System for Emacs org-mode
https://www.leonrische.me/fc/index.html
GNU General Public License v3.0
259 stars 31 forks source link

Documentation: Spacemacs recipe incorrect #50

Closed iogrt closed 3 years ago

iogrt commented 3 years ago

First of all, thank you for making this package! I'm looking forward to setup SRS inside emacs.

I went to the Documentation you provided and noticed the spacemacs installation script is incorrect: it uses "repo" instead of "url", this won't work since you are not fetching from github/gitlab.

Install script on documentation:

dotspacemacs-additional-packages
'((org-fc
   :location (recipe :fetcher git
                     :repo "l3kn/org-fc"
                     :repo "https://git.sr.ht/~l3kn/org-fc" ; error here
                     :files (:defaults "awk" "demo.org"))))
;; ...
(defun dotspacemacs/user-config ()
  ;; ...
  ;; Org-fc
  (use-package hydra)
  (require 'org-fc-hydra)
  (setq org-fc-directories '("~/org/"))
  ;; ...
  )

Correct install script:

dotspacemacs-additional-packages
'((org-fc
   :location (recipe :fetcher git
                     :url "https://git.sr.ht/~l3kn/org-fc"
                     :files (:defaults "awk" "demo.org"))))
;; ...
(defun dotspacemacs/user-config ()
  ;; ...
  ;; Org-fc
  (use-package hydra)
  (require 'org-fc-hydra)
  (setq org-fc-directories '("~/org/"))
  ;; ...
  )
l3kn commented 3 years ago

Thanks, I've updated the docs.