https://github.com/agrafix/hackmanager
Simplify managing Haskell projects by generating files like README.md, .travis.yml, etc.
https://github.com/agrafix/hackmanager
Last synced: about 1 year ago
JSON representation
Simplify managing Haskell projects by generating files like README.md, .travis.yml, etc.
- Host: GitHub
- URL: https://github.com/agrafix/hackmanager
- Owner: agrafix
- License: bsd-3-clause
- Created: 2015-08-23T13:06:15.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-08-23T14:52:03.000Z (almost 11 years ago)
- Last Synced: 2025-05-10T06:36:57.485Z (about 1 year ago)
- Language: Haskell
- Size: 129 KB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
hackmanager
=====
[](https://travis-ci.org/agrafix/hackmanager)
[](http://hackage.haskell.org/package/hackmanager)
## Intro
Hackage: [hackmanager](http://hackage.haskell.org/package/hackmanager)
Stackage: [hackmanager](https://www.stackage.org/package/hackmanager)
Generate useful files for Haskell projects
## Cli Usage: hackmanager
```sh
$ hackmanager --help
hackmanager - Generate useful files for Haskell projects
Usage: hackmanager COMMAND
Simplify managing Haskell projects by generating files like README.md,
.travis.yml, etc.
Available options:
-h,--help Show this help text
Available commands:
readme
travis
gitignore
(c) 2015 Alexander Thiemann - BSD3 License
```
## Library Usage Example
```haskell
module Main where
import Hack.Manager.Collector
import Hack.Manager.Readme
import qualified Data.Text as T
main :: IO ()
main =
do pi <- getProjectInfo
case pi of
Left err -> putStrLn err
Right info ->
do rm <- renderReadme info
putStrLn (T.unpack rm)
```
## Install
* Using cabal: `cabal install hackmanager`
* Using Stack: `stack install hackmanager`
* From Source (cabal): `git clone https://github.com/agrafix/hackmanager.git && cd hackmanager && cabal install`
* From Source (stack): `git clone https://github.com/agrafix/hackmanager.git && cd hackmanager && stack build`
## Features
* Automagically collect package information such as
* package name
* GHC compatibility
* stack Project
* Hackage / Stackage status
* License
* Examples
* Cli Usage
* Typecheck examples
* Generate informative README.md (Can be extended using a MORE.md)
* Generate .travis.yml (cabal or stack based)
* Generate .gitignore
The generated `.travis.yml` and `.gitignore` are intended as starting templates, while the generated `README.md` should not be modified by hand. Rerun `hackmanager readme` before every commit (commit hook?) to keep it up to date. If you would like to add custom sections, create a `MORE.md`.
## Roadmap
There's no real roadmap - I will add features as needed. I am open to any contributions!
## Misc
### Supported GHC Versions
* 7.10.2
### License
Released under the BSD3 license.
(c) 2015 Alexander Thiemann