summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeon Rische <leon.rische@me.com>2020-04-21 16:05:33 +0200
committerLeon Rische <leon.rische@me.com>2020-04-21 16:05:33 +0200
commit8d7662a7acd552dc3acf6c2f62418d9ef7a541ad (patch)
treebc421aaa647c8fa764972986b2b63f99cbd3e901
parent0d7e1eba82da1fd886f07b06a993795caa5c8a10 (diff)
Add installation instructions for MacOS
-rw-r--r--README.org23
1 files changed, 20 insertions, 3 deletions
diff --git a/README.org b/README.org
index 368f15a..0c2f335 100644
--- a/README.org
+++ b/README.org
@@ -77,16 +77,33 @@ to install it, clone the repository (e.g. to ~src/org-fc/~)
and follow the setup instructions.
*** Dependencies
-This package depends on the =gawk= extension of =awk=.
+- The =gawk= extension of =awk= for extracting review data from =.org= files
+- =find= for finding all org files in the ~org-fc-directories~
+- =xargs= for processing files in parallel
+**** Linux / UNIX
+=find= and =xargs= should be included in most distributions, =gawk=
+can be installed from source or using your package manager of choice.
Examples:
-
- =pacman -S gawk= (Arch Linux)
- =apt-get install gawk= (Ubuntu, Debian, ...)
- =yum install gawk= (CentOS)
-- =brew install gawk= (macOS, using [[https://brew.sh/][homebrew]])
For more information, see [[https://www.gnu.org/software/gawk/manual/html_node/Installation.html][gawk manual - Installation]].
+**** MacOS
+On MacOS all dependencies can be installed using [[https://www.macports.org/][macports]] or [[https://brew.sh/][homebrew]].
+=find= and =xargs= are part of the =findutils= package.
+
+- =port install gawk findutils=
+- =brew install gawk findutils=
+
+You might have to adjust your =$PATH= to make sure Emacs can find all
+relevant binaries.
+
+~export PATH="/opt/local/libexec/gnubin:/opt/local/bin:$PATH"~
+
+For more information, refer to the documentation of macports /
+homebrew.
*** Setup with [[https://github.com/jwiegley/use-package/][use-package]]
#+begin_src emacs-lisp
(use-package hydra)