2020-07-12 14:07:45 +10:00
|
|
|
# cadmus
|
|
|
|
|
Shell Scripts to Facilitate Effective Note Taking
|
2020-07-13 00:11:59 +10:00
|
|
|
|
2020-07-13 00:22:22 +10:00
|
|
|
## Philosophy
|
|
|
|
|
|
2020-07-13 00:50:04 +10:00
|
|
|
- Be a Front end to tie together different scripts and tools
|
|
|
|
|
- Don't replicate work other people have done.
|
|
|
|
|
- Plain Text, Open Source.
|
2020-07-13 00:22:22 +10:00
|
|
|
|
2020-07-13 00:11:59 +10:00
|
|
|
## Installation
|
|
|
|
|
|
2020-07-13 00:50:04 +10:00
|
|
|
To install, satisfy [the dependencies](#Dependencies) and do something like this:
|
2020-07-12 22:07:01 +10:00
|
|
|
|
2020-07-13 00:11:59 +10:00
|
|
|
```bash
|
|
|
|
|
cd ~/DotFiles
|
|
|
|
|
|
|
|
|
|
if [[ -d ".git" ]]; then
|
|
|
|
|
echo "Adding Submodule";
|
2020-07-13 00:22:22 +10:00
|
|
|
git submodule add https://github.com/RyanGreenup/cadmus
|
2020-07-13 00:11:59 +10:00
|
|
|
else echo "Cloning Repository";
|
2020-07-13 00:22:22 +10:00
|
|
|
git clone https://github.com/RyanGreenup/cadmus
|
2020-07-13 00:11:59 +10:00
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
stow -t $HOME -S cadmus
|
|
|
|
|
```
|
2020-07-12 22:07:01 +10:00
|
|
|
|
2020-07-13 00:50:04 +10:00
|
|
|
## Usage
|
|
|
|
|
|
2020-07-12 22:07:01 +10:00
|
|
|
## Dependencies
|
|
|
|
|
|
2020-07-12 22:08:13 +10:00
|
|
|
- [R](https://en.wikipedia.org/wiki/R_(programming_language))
|
|
|
|
|
- [highlight](https://www.archlinux.org/packages/community/x86_64/highlight/)
|
|
|
|
|
- [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)
|
|
|
|
|
- [rg](https://www.google.com/search?client=firefox-b-d&q=ripgrep+github)
|
|
|
|
|
- [perl](https://wiki.archlinux.org/index.php/Perl)
|
|
|
|
|
- [stow](https://www.google.com/search?client=firefox-b-d&q=gnu+stow)
|
|
|
|
|
- [python](https://www.python.org/download/releases/3.0/)
|
|
|
|
|
- [tmsu](https://aur.archlinux.org/packages/tmsu/)<sup>AUR</sup>
|
|
|
|
|
- [ranger](https://www.archlinux.org/packages/community/any/ranger/)
|
|
|
|
|
- [mdcat](https://aur.archlinux.org/packages/mdcat/)<sup>AUR</sup>
|
2020-07-13 00:28:57 +10:00
|
|
|
- [Kitty](https://sw.kovidgoyal.net/kitty/) or [iterm2](https://www.iterm2.com/)
|
2020-07-12 22:08:13 +10:00
|
|
|
- [xclip](https://www.archlinux.org/packages/extra/x86_64/xclip/)
|
|
|
|
|
- [sd](https://github.com/chmln/sd)
|
|
|
|
|
- [fd](https://github.com/sharkdp/fd)
|
|
|
|
|
- [sed](https://www.gnu.org/software/sed/)
|
|
|
|
|
- [cut](https://www.gnu.org/software/coreutils/manual/html_node/The-cut-command.html)
|
|
|
|
|
- [grep](https://www.gnu.org/software/grep/)
|
|
|
|
|
- [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)
|
2020-07-13 00:28:57 +10:00
|
|
|
- [Recoll](https://www.lesbonscomptes.com/recoll/)
|
2020-07-13 00:50:04 +10:00
|
|
|
- [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/)
|
2020-07-13 00:52:31 +10:00
|
|
|
- [VNote](https://github.com/tamlok/vnote)
|
2020-07-13 00:59:48 +10:00
|
|
|
- [Pandoc](https://github.com/jgm/pandoc)
|
2020-07-13 00:28:57 +10:00
|
|
|
|
2020-07-13 00:30:51 +10:00
|
|
|
|
|
|
|
|
## Related
|
|
|
|
|
|
|
|
|
|
- [DNote]
|
|
|
|
|
- [TNote]
|
|
|
|
|
- [Notable]
|
|
|
|
|
|
|
|
|
|
[Notable]: https://github.com/notable/notable
|
|
|
|
|
[TNote]: https://github.com/tasdikrahman/tnote
|
|
|
|
|
[DNote]: https://github.com/dnote
|
