mirror/cadmus
1
0
Fork 0
mirror of https://github.com/RyanGreenup/cadmus.git synced 2025-08-01 03:40:11 +02:00
Code Issues Releases Wiki Activity

Added to the Help File

Browse Source
This commit is contained in:
Ryan Greenup
2020-07-16 05:37:29 +10:00
parent 8552fab285
commit d2a7f3f575
1 changed files with 23 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -38,28 +38,33 @@ this is an attempt to wrap them into a single script and then have aliases to ma
## Installation ## Installation
To install, satisfy [the dependencies](#Dependencies), [Set up Recoll](#Configuring-recoll) and add `$HOME/bin` to the `$PATH` variable, something like this should be fairly shell agnostic: To install:
``` bash 1. satisfy [the dependencies](#Dependencies)
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 2. [Set up Recoll](#Configuring-recoll)
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. Copy the help files to `/usr/share/cadmus`
then copy in the scripts, with [*stow*] something like this should be sensible: 5. Copy in the scripts, with [*stow*] something like this should be sensible:
```bash ```bash
exec bash exec bash
cd ~/DotFiles cd ~/DotFiles
if [[ -d ".git" ]]; then if [[ -d ".git" ]]; then
echo "Adding Submodule"; echo "Adding Submodule";
git submodule add https://github.com/RyanGreenup/cadmus git submodule add https://github.com/RyanGreenup/cadmus
else echo "Cloning Repository"; else echo "Cloning Repository";
git clone https://github.com/RyanGreenup/cadmus git clone https://github.com/RyanGreenup/cadmus
fi fi
stow -t $HOME -S cadmus stow -t $HOME -S cadmus
``` ```
|:warning: WARNING | |:warning: WARNING |
| --- | | --- |