Create README.md
This commit is contained in:
parent
2ee3d94d3e
commit
29ff47733f
14
README.md
Normal file
14
README.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
# timecode-generator
|
||||
A simple Haskell script for creating timecodes by tracking changes in remote Markdown file
|
||||
|
||||
**Requimpments**
|
||||
- Nix package manager installed
|
||||
## Installing
|
||||
Clone repository and run `nix-build -A pkgs.haskell.packages.ghc8107.timecode-generator` inside directory
|
||||
|
||||
You'll find binary in `./result/bin/timecode-generator`
|
||||
#### In nix-shell
|
||||
run `nix-shell` and then compile it with cabal inside (`cabal build timecode-generator`)
|
||||
|
||||
## how to use
|
||||
`./timecode-generator <URL to fetch> <Timecode filename>`
|
Loading…
Reference in a new issue