Thanks for starting a project with Haskeleton! If you haven't heard of it before, I suggest reading the introductory blog post. You can find it here: http://taylor.fausak.me/2014/03/04/haskeleton-a-haskell-project-skeleton/.
Before you get started, there are a few things that this template couldn't provide for you. You should:
-
Add a synopsis to
package.yaml. It should be a short (one sentence) explanation of your project. -
Add a description to
package.yaml. This can be whatever you want it to be. -
Add a category to
package.yaml. A list of categories is available on Hackage at http://hackage.haskell.org/packages. -
Rename
library/Example.hsto whatever you want your top-level module to be called. Typically this is the same as your package name but inCamelCaseinstead ofkebab-case.- Don't forget to rename the reference to it in
executable/Main.hs!
- Don't forget to rename the reference to it in
-
If you are on an older version of Stack (<1.0.4), delete
package.yamland remove/*.cabalfrom your.gitignore.
Once you've done that, start working on your project with the Stack commands you know and love.
# Build the project.
stack build
# Run the test suite.
stack test
# Run the benchmarks.
stack bench
# Generate documentation.
stack haddockThanks again, and happy hacking!