scripts/README.md

43 lines
1,020 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Ayo's Scripts
Personal BASH scripts for productivity
## Setup
1\. clone the repo
```bash
$ git clone git@git.sr.ht:~ayoayco/scripts
```
2\. Copy config and populate
```bash
$ cp example.config ~/ayo.conf
$ vim ~/ayo.conf
```
3\. update your .bashrc to add an alias for the parent command `scripts/ayo.sh`
## Dependencies
1. Typora - used as default editor for notes
## Scripts
1. ayo - parent command, lists all available scripts or accepts parameters
1. journal - creates a new journal entry if it doesnt exist yet; opens on editor
1. append - append one thought at the end of the day's entry
1. notes - notes management
1. git (g) - args can be list of files to commit & push
1. stat (gs) - git status
1. push (gp) - git push
## Features
1. Autosync for notes & journal via git
## Planned
1. blog - tools for blogging (eg, bn - generate blog from a note)
1. config - create configuration for variables (eg, editor, locations)
---
*Just keep scripting.*
*A project by [Ayo](https://ayo.ayco.io)*