timecodeg/README.md

18 lines
796 B
Markdown

# timecode-generator
A simple Haskell script for creating timecodes by tracking changes in remote text 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>`
## Other info
**Correct link to file**: It should be a direct link to file itself. _Example:_ for hedgedoc the link isn't a https://hedgedoc.domain/AjCE6BZzTW2IHusdfwhRg it is a https://hedgedoc.domain/AjCE6BZzTW2IHusdfwhRg + **/download** to get directly to pure markdown file