scripts: Add simple readme
Added readme file explaining the ethereal nature of this module.
This commit is contained in:
parent
c2f3e38e82
commit
a0bb818643
1 changed files with 29 additions and 0 deletions
29
scripts/README.md
Normal file
29
scripts/README.md
Normal file
|
@ -0,0 +1,29 @@
|
|||
# Scripts module
|
||||
|
||||
The scripts module contains several small shell scripts which did not fit under any specific module.
|
||||
Many of these modules are older and either 'legacy' in that they work but should be restructured at some point,
|
||||
or perhaps not working at all anymore.
|
||||
|
||||
Some will work for others without needing changes, some are very personalized to me.
|
||||
|
||||
## benchmark
|
||||
|
||||
`benchmark` allows you to take the time another commands needs to run.
|
||||
It will simply output the time taken, and can be run repeatedly or averaged to get more accurate readings.
|
||||
|
||||
## compile
|
||||
|
||||
`compile` is somewhat of a left-over script.
|
||||
It should be refactored and moved into the `bibtex` module at some point.
|
||||
It takes a filename and tries to invoke the corresponding compiler and is mainly used by my `pandoc` (or `rmarkdown`) workflow.
|
||||
`open-compiled` is somewhat of a companion script which attempts to open the resulting file for the user.
|
||||
|
||||
## lockscreen
|
||||
|
||||
`lockscreen` does just that, invoke the i3 lock-screen program with some simple defaults and a color.
|
||||
|
||||
|
||||
## nomie
|
||||
|
||||
`nomie` logs a simple journal entry in the open source habit-tracking app [nomie](https://nomie.app).
|
||||
To do this it needs an api key, which is, as of now, hard-coded to be sourced from my pass app.
|
Loading…
Reference in a new issue