Add basic documentation
This commit is contained in:
parent
1620b36b70
commit
014f1fbbe6
4 changed files with 31 additions and 0 deletions
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
vendor
|
||||
_build
|
24
README.md
Normal file
24
README.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
# Randomedit
|
||||
|
||||
For when you can't decide what you want to start with.
|
||||
|
||||
## Installation
|
||||
|
||||
:warning: FIXME
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Watch a random movie
|
||||
|
||||
EDITOR=mpv randomedit -p '*.mkv' -p '*.mp4' -d ~/Movies
|
||||
|
||||
Read a random PDF
|
||||
|
||||
EDITOR=okular randomedit -p '*.pdf' -d ~/Documentation/
|
||||
|
||||
## Authors & license
|
||||
|
||||
:warning: FIXME
|
||||
|
||||
|
3
go.mod
Normal file
3
go.mod
Normal file
|
@ -0,0 +1,3 @@
|
|||
module github.com/glenux/randomedit
|
||||
|
||||
require github.com/spf13/pflag v1.0.2
|
2
go.sum
Normal file
2
go.sum
Normal file
|
@ -0,0 +1,2 @@
|
|||
github.com/spf13/pflag v1.0.2 h1:Fy0orTDgHdbnzHcsOgfCN4LtHf0ec3wwtiwJqwvf3Gc=
|
||||
github.com/spf13/pflag v1.0.2/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
|
Loading…
Reference in a new issue