forked from RyanGreenup/cadmus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.html
137 lines (132 loc) · 7.56 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>README.html</title>
<meta http-equiv="Content-Type" content="application/xhtml+xml;charset=utf-8"/>
<link rel="stylesheet" type="text/css" media="all" href="https://cdn.jsdelivr.net/npm/github-markdown-css/github-markdown.min.css" />
<link rel="stylesheet" type="text/css" media="all" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release/build/styles/github.min.css" /><meta name='viewport' content='width=device-width, initial-scale=1, shrink-to-fit=no'><style> body { box-sizing: border-box; max-width: 740px; width: 100%; margin: 40px auto; padding: 0 10px; } </style><script src='https://cdn.jsdelivr.net/gh/highlightjs/cdn-release/build/highlight.min.js'></script><script>document.addEventListener('DOMContentLoaded', () => { document.body.classList.add('markdown-body'); document.querySelectorAll('pre[lang] > code').forEach((code) => { code.classList.add(code.parentElement.lang); }); document.querySelectorAll('pre > code').forEach((code) => { hljs.highlightBlock(code); }); });</script>
</head>
<body>
<h1 id="cadmus">cadmus</h1>
<p>Shell Scripts to Facilitate Effective Note Taking</p>
<h2 id="introduction">Introduction</h2>
<p>Essentially I <del>used to</del> have a dozen shell scripts in <code>~/bin</code> 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.</p>
<p><img src="./MainMenu.png" /></p>
<h2 id="philosophy">Philosophy</h2>
<ul>
<li>Be a Front end to tie together different scripts and tools</li>
<li>Don’t replicate work other people have done.</li>
<li>Plain Text, Open Source.</li>
<li>Be Modular
<ul>
<li>Pipe in input, output goes to STDOUT</li>
<li>Leave Aliases and piping to the user
<ul>
<li>See <a href="#recommended-aliases">Recommended Aliases</a></li>
</ul></li>
</ul></li>
</ul>
<h2 id="installation">Installation</h2>
<p>To install, satisfy <a href="#Dependencies">the dependencies</a> and do something like this:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true"></a><span class="bu">cd</span> ~/DotFiles</span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true"></a></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true"></a><span class="kw">if [[</span> <span class="ot">-d</span> <span class="st">".git"</span><span class="kw"> ]]</span>; <span class="kw">then</span></span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true"></a> <span class="bu">echo</span> <span class="st">"Adding Submodule"</span><span class="kw">;</span></span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true"></a> <span class="fu">git</span> submodule add https://github.com/RyanGreenup/cadmus</span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true"></a><span class="kw">else</span> <span class="bu">echo</span> <span class="st">"Cloning Repository"</span><span class="kw">;</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true"></a> <span class="fu">git</span> clone https://github.com/RyanGreenup/cadmus</span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true"></a><span class="kw">fi</span></span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true"></a></span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true"></a><span class="ex">stow</span> -t <span class="va">$HOME</span> -S cadmus</span></code></pre></div>
<table>
<colgroup>
<col style="width: 100%" />
</colgroup>
<thead>
<tr class="header">
<th>:warning: WARNING</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Stow is <a href="https://github.com/aspiers/stow/issues/65">currently broken</a> on Arch If you are using Stow 2.3.1-2 downgrade</td>
</tr>
</tbody>
</table>
<blockquote>
<p>Downgrade with: sudo pacman -U https://archive.archlinux.org/packages/s/stow/stow-2.2.2-5-any.pkg.tar.xz</p>
</blockquote>
<h2 id="usage">Usage</h2>
<p>It’s all Menu driven so just follow the diagram to do what you need.</p>
<figure>
<img src="./usage.svg" title="Diagram of the flow of the script" alt="" /><figcaption>Mindmap of Program Flow</figcaption>
</figure>
<h3 id="assumptions">Assumptions</h3>
<p>It is assumed that:</p>
<ol type="1">
<li>notes are:
<ol type="1">
<li><em>Markdown</em> files with a <code>.md</code> extension</li>
<li>Underneath <code>~/Notes</code></li>
<li>Recoll updates it’s index on the fly
<ul>
<li><code>~/Notes</code> will need to be indexed by <em>Recoll</em> so the results will show up.</li>
</ul></li>
</ol></li>
<li>You’re going to use <a href="https://sw.kovidgoyal.net/kitty/">Kitty</a>
<ul>
<li>You could either change the source or use anoter terminal that supports calling functions with <code>--</code>, e.g. <code>kitty -- nvim</code></li>
</ul></li>
</ol>
<h2 id="dependencies">Dependencies</h2>
<ul>
<li><a href="https://en.wikipedia.org/wiki/R_(programming_language)">R</a></li>
<li><a href="https://www.archlinux.org/packages/community/x86_64/highlight/">highlight</a></li>
<li><a href="https://www.archlinux.org/packages/extra/x86_64/recode/">recode</a></li>
<li><a href="https://nodejs.org/en/">node</a></li>
<li><a href="https://neovim.io/">nvim</a></li>
<li><a href="https://github.com/junegunn/fzf">fzf</a></li>
<li><a href="https://github.com/lotabout/skim">code</a></li>
<li><a href="https://github.com/lotabout/skim">sk</a></li>
<li><a href="https://www.google.com/search?client=firefox-b-d&q=ripgrep+github">rg</a></li>
<li><a href="https://wiki.archlinux.org/index.php/Perl">perl</a></li>
<li><a href="https://www.google.com/search?client=firefox-b-d&q=gnu+stow">stow</a></li>
<li><a href="https://www.python.org/download/releases/3.0/">python</a></li>
<li><a href="https://aur.archlinux.org/packages/tmsu/">tmsu</a><sup>AUR</sup></li>
<li><a href="https://www.archlinux.org/packages/community/any/ranger/">ranger</a></li>
<li><a href="https://aur.archlinux.org/packages/mdcat/">mdcat</a><sup>AUR</sup>
<ul>
<li><a href="https://sw.kovidgoyal.net/kitty/">Kitty</a>
<ul>
<li>I’ve also heard good things about <a href="https://www.iterm2.com/">iterm2</a></li>
</ul></li>
</ul></li>
<li><a href="https://www.archlinux.org/packages/extra/x86_64/xclip/">xclip</a></li>
<li><a href="https://github.com/chmln/sd">sd</a></li>
<li><a href="https://github.com/sharkdp/fd">fd</a></li>
<li><a href="https://www.gnu.org/software/sed/">sed</a></li>
<li><a href="https://www.gnu.org/software/coreutils/manual/html_node/The-cut-command.html">cut</a></li>
<li><a href="https://www.gnu.org/software/grep/">grep</a></li>
<li><a href="https://man7.org/linux/man-pages/man1/find.1.html">find</a></li>
<li><a href="https://www.gnu.org/software/coreutils/manual/html_node/realpath-invocation.html#realpath-invocation">GNU realpath</a></li>
<li><a href="https://www.lesbonscomptes.com/recoll/">Recoll</a></li>
<li><a href="https://pypi.org/project/mkdocs-material-extensions/">MkDocs</a>
<ul>
<li><a href="https://github.com/squidfunk/mkdocs-material">MkDocs Material Theme</a></li>
<li><a href="https://pypi.org/project/mkdocs-material-extensions/">MkDocs Material Extensions</a></li>
</ul></li>
<li><a href="https://github.com/tamlok/vnote">VNote</a></li>
<li><a href="https://github.com/jgm/pandoc">Pandoc</a></li>
</ul>
<h2 id="recommended-aliases">Recommended Aliases</h2>
<p>TODO</p>
<h2 id="related">Related</h2>
<ul>
<li><a href="https://github.com/dnote">DNote</a></li>
<li><a href="https://github.com/tasdikrahman/tnote">TNote</a></li>
<li><a href="https://github.com/notable/notable">Notable</a></li>
</ul>
</body>
</html>