# cadmus

Shell Scripts to Facilitate Effective Note Taking

## Introduction

Essentially I used to have a dozen shell scripts in `~/bin` that I use to capture notes, this is an attempt to wrap them into a single script and then have aliases to make them quick to access.

## Philosophy

- Be a Front end to tie together different scripts and tools
- Don’t replicate work other people have done.
- Plain Text, Open Source.
- Be Modular
  - Pipe in input, output goes to STDOUT
  - Leave Aliases and piping to the user
    - See Recommended Aliases

## Installation

To install, satisfy the dependencies and do something like this:

    cd ~/DotFiles

    if [[ -d ".git" ]]; then
        echo "Adding Submodule";
        git submodule add https://github.com/RyanGreenup/cadmus
    else echo "Cloning Repository";
        git clone https://github.com/RyanGreenup/cadmus
    fi

    stow -t $HOME -S cadmus

:warning: WARNING
Stow is currently broken on Arch If you are using Stow 2.3.1-2 downgrade

> Downgrade with: sudo pacman -U https://archive.archlinux.org/packages/s/stow/stow-2.2.2-5-any.pkg.tar.xz

## Usage

It’s all Menu driven so just follow the diagram to do what you need.

Mindmap of Program Flow

### Assumptions

It is assumed that:

1. notes are:
   1. Markdown files with a `.md` extension
   2. Underneath `~/Notes`
   3. Recoll updates it’s index on the fly
      - `~/Notes` will need to be indexed by Recoll so the results will show up.
2. You’re going to use Kitty
   - You could either change the source or use anoter terminal that supports calling functions with `--`, e.g. `kitty -- nvim`

## Dependencies

- R
- highlight
- recode
- node
- nvim
- fzf
- code
- sk
- rg
- perl
- stow
- python
- tmsuAUR
- ranger
- mdcatAUR
  - Kitty
    - I’ve also heard good things about iterm2
- xclip
- sd
- fd
- sed
- cut
- grep
- find
- GNU realpath
- Recoll
- MkDocs
  - MkDocs Material Theme
  - MkDocs Material Extensions
- VNote
- Pandoc

## Recommended Aliases

TODO

## Related

- DNote
- TNote
- Notable