Create README.md

This commit is contained in:
George 2022-02-10 11:44:55 +03:00 committed by GitHub
parent 2ee3d94d3e
commit 29ff47733f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

14
README.md Normal file
View 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>`