commit a0b403cba6e4600a38312db23629089befce6911 parent 76cdf7c27c9cb219a3e06edb1e8c220e3b8ad55b Author: JayVii <jayvii[AT]posteo[DOT]de> Date: Sat, 29 Jun 2024 21:26:31 +0200 feat: transform readme to markdown Diffstat:
| D | README | | | 36 | ------------------------------------ |
| A | README.md | | | 39 | +++++++++++++++++++++++++++++++++++++++ |
2 files changed, 39 insertions(+), 36 deletions(-)
diff --git a/README b/README @@ -1,36 +0,0 @@ -plain_notes -=========== - -requirements ------------- - -- bash -- GNU tools - - cat - - find - - sed - - sort - - uniq - - date -- some text editor (default: "vi") -- https://github.com/junegunn/fzf - -Getting started ---------------- - -Getting the script - - mkdir -p ~/.local/bin/ - wget https://src.jayvii.de/pub/plain_notes/exports/main.tar.gz -O ~/.local/bin/plain_notes.tar.gz - cd ~/.local/bin/ - tar xfvz plain_notes.tar.gz - chmod +x ~/.local/bin/notes.sh - -Ease of use additions - - echo "PATH=$PATH:$HOME/.local/bin" >> ~/.bashrc - echo "alias notes=$HOME/.local/bin/notes.sh" >> ~/.bashrc - -Running the script may be done in an endless loop: - - while :; ~/.local/bin/notes.sh; done diff --git a/README.md b/README.md @@ -0,0 +1,39 @@ +# plain_notes + +## requirements + +- bash +- GNU tools + - cat + - find + - sed + - sort + - uniq + - date +- some text editor (default: "vi") +- [fzf](https://github.com/junegunn/fzf) + +## Getting started + +Getting the script + +```bash +mkdir -p ~/.local/bin/ +wget https://src.jayvii.de/pub/plain_notes/exports/main.tar.gz -O ~/.local/bin/plain_notes.tar.gz +cd ~/.local/bin/ +tar xfvz plain_notes.tar.gz +chmod +x ~/.local/bin/notes.sh +``` + +Ease of use additions + +```bash +echo "PATH=$PATH:$HOME/.local/bin" >> ~/.bashrc +echo "alias notes=$HOME/.local/bin/notes.sh" >> ~/.bashrc +``` + +Running the script may be done in an endless loop: + +```bash +while :; ~/.local/bin/notes.sh; done +```