From 6d2d54c0aaae5c5e1a1460568b3d5067af57abb0 Mon Sep 17 00:00:00 2001 From: Ryan Greenup Date: Fri, 17 Jul 2020 04:28:18 +1000 Subject: [PATCH] Improved Install Instructions --- README.md | 93 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 57 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index eb07640..a634952 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,35 @@ To install: 1. satisfy [the dependencies](#Dependencies) 2. [Set up Recoll](#Configuring-recoll) +3. Download cadmus and put it in the `PATH` + ```bash + mkdir ~/.cadmus && \ + clone https://github.com/RyanGreenup/cadmus ~/.cadmus \ + || echo "Delete ~/.cadmus first" + ln -s ~/.cadmus/bin/cadmus $HOME/bin/ + ``` 3. add `$HOME/bin` to the `$PATH` variable, something like this should be fairly shell agnostic: ``` bash echo $PATH | grep "$HOME/bin" &> /dev/null && echo "$HOME/bin in path already" || ls "$HOME/bin" &> /dev/null && echo 'PATH="$PATH:$HOME/bin"' >> $HOME/.profile ``` + +4. You will probably need to change the directory to your notes in the script: + + ```bash + which cadmus | xargs xdg-open + ``` + + ``` + readonly NOTES_DIR="$HOME/Notes/" + readonly SERVER_DIR="/var/www/html/MD" + readonly MKDOCS_YML="$HOME/Notes/mkdocs.yml" + ``` + + + + +--> ### Configuring recoll -Currently the search just uses the default recoll config, I intend to modify this to use `~/.cadmus` as a config directory so as to not interfere with the default config but it isn't in practice an issue because you can just modify the `sk` in ..cadmus.. to start the call with `~/Notes/MD`. +Currently the search just uses the default recoll config, I intend to modify this to use `~/.cadmus` as a config directory so as to not interfere with the default config. + +It isn't in practice an issue if `~/.recoll` is indexing more than the notes because you can just modify the call to *Skim* (`sk`) in ..cadmus.. to start the call with `~/Notes/MD`. + [*nushell*]: https://github.com/nushell/nushell [*Fish*]: https://fishshell.com/ @@ -140,23 +163,21 @@ It is assumed that: ## Dependencies -- [R](https://en.wikipedia.org/wiki/R_(programming_language)) + - [highlight](https://www.archlinux.org/packages/community/x86_64/highlight/) - [recode](https://www.archlinux.org/packages/extra/x86_64/recode/) - [node](https://nodejs.org/en/) -- [nvim](https://neovim.io/) - [fzf](https://github.com/junegunn/fzf) -- [code](https://github.com/lotabout/skim) -- [sk](https://github.com/lotabout/skim) +- [skim](https://github.com/lotabout/skim) - [rg](https://www.google.com/search?client=firefox-b-d&q=ripgrep+github) - [perl](https://wiki.archlinux.org/index.php/Perl) -- [*stow*] - [python](https://www.python.org/download/releases/3.0/) - [tmsu](https://aur.archlinux.org/packages/tmsu/)AUR - [ranger](https://www.archlinux.org/packages/community/any/ranger/) - [mdcat](https://aur.archlinux.org/packages/mdcat/)AUR - - [Kitty](https://sw.kovidgoyal.net/kitty/) - - I've also heard good things about [iterm2](https://www.iterm2.com/) - [xclip](https://www.archlinux.org/packages/extra/x86_64/xclip/) - [sd](https://github.com/chmln/sd) - [fd](https://github.com/sharkdp/fd) @@ -166,12 +187,7 @@ It is assumed that: - [find](https://man7.org/linux/man-pages/man1/find.1.html) - [GNU realpath](https://www.gnu.org/software/coreutils/manual/html_node/realpath-invocation.html#realpath-invocation) - [Recoll](https://www.lesbonscomptes.com/recoll/) -- [MkDocs](https://pypi.org/project/mkdocs-material-extensions/) - - [MkDocs Material Theme](https://github.com/squidfunk/mkdocs-material) - - [MkDocs Material Extensions](https://pypi.org/project/mkdocs-material-extensions/) -- [VNote](https://github.com/tamlok/vnote) - [Pandoc](https://github.com/jgm/pandoc) -- [MarkText](https://github.com/marktext/marktext) - [bat](https://github.com/sharkdp/bat) ### PATH @@ -204,15 +220,24 @@ set PATH "$HOME/.cargo/bin $PATH - [WeasyPrint](https://aur.archlinux.org/packages/python-weasyprint/) - [tectonic](https://tectonic-typesetting.github.io/en-US/) +- [nvim](https://neovim.io/) +- [Kitty](https://sw.kovidgoyal.net/kitty/) + - I've also heard good things about [iterm2](https://www.iterm2.com/) +- [MkDocs](https://pypi.org/project/mkdocs-material-extensions/) + - [MkDocs Material Theme](https://github.com/squidfunk/mkdocs-material) + - [MkDocs Material Extensions](https://pypi.org/project/mkdocs-material-extensions/) +- [MarkText](https://github.com/marktext/marktext) +- [VNote](https://github.com/tamlok/vnote) -### Interesting or Helpful packages not required +### recommended / Interesting / Helpful packages not required - [readability-cli](https://gitlab.com/gardenappl/readability-cli) - mdless +- VSCode ## Recommended Aliases -TODO +I wrote all this with aliases in mind, when I settle on some aliases i'll put up my `fish` functions. (I also wanted to do some autocomplete.) ## Related @@ -229,7 +254,3 @@ TODO [^wpdtmpfs]: [From Wikipedia][shared_memory] Recent 2.6 Linux kernel builds have started to offer /dev/shm as shared memory in the form of a ramdisk, more specifically as a world-writable directory that is stored in memory with a defined limit in /etc/default/tmpfs. /dev/shm support is completely optional within the kernel config file. [*stow*]: https://www.google.com/search?client=firefox-b-d&q=gnu+stow - -## MDCat vs Bat - -MdCat looks better and supports images, unfourtunately the preview fails when files have footnotes and for this reason bat was used (bat is also in the Arch repos and supports more file types)