mirror of
https://github.com/RyanGreenup/cadmus.git
synced 2025-08-13 09:35:22 +02:00
MkDocs Dep
This commit is contained in:
19
README.md
19
README.md
@@ -3,19 +3,13 @@ Shell Scripts to Facilitate Effective Note Taking
|
|||||||
|
|
||||||
## Philosophy
|
## Philosophy
|
||||||
|
|
||||||
Don't replicate work other people have done.
|
- Be a Front end to tie together different scripts and tools
|
||||||
|
- Don't replicate work other people have done.
|
||||||
|
- Plain Text, Open Source.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Use the script that basically [does this](#manually):
|
To install, satisfy [the dependencies](#Dependencies) and do something like this:
|
||||||
|
|
||||||
```bash
|
|
||||||
https://raw.githubusercontent.com/RyanGreenup/cadmus/master/install.sh?token=ALM54ERFSACJUIT7D5Q2L7S7CQ4QY | bash
|
|
||||||
```
|
|
||||||
|
|
||||||
### Manually
|
|
||||||
|
|
||||||
To install manually, satisfy [the dependencies](#Dependencies) and do something like this:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd ~/DotFiles
|
cd ~/DotFiles
|
||||||
@@ -30,6 +24,8 @@ fi
|
|||||||
stow -t $HOME -S cadmus
|
stow -t $HOME -S cadmus
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
- [R](https://en.wikipedia.org/wiki/R_(programming_language))
|
- [R](https://en.wikipedia.org/wiki/R_(programming_language))
|
||||||
@@ -56,6 +52,9 @@ stow -t $HOME -S cadmus
|
|||||||
- [find](https://man7.org/linux/man-pages/man1/find.1.html)
|
- [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)
|
- [GNU realpath](https://www.gnu.org/software/coreutils/manual/html_node/realpath-invocation.html#realpath-invocation)
|
||||||
- [Recoll](https://www.lesbonscomptes.com/recoll/)
|
- [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/)
|
||||||
|
|
||||||
|
|
||||||
## Related
|
## Related
|
||||||
|
Reference in New Issue
Block a user