Commit 50fe7087 authored by Paul Ogris's avatar Paul Ogris
Browse files

Update readme

parent 24f3072b
# [lars-relax][] # lars-relax
Thanks for starting a project with Haskeleton! If you haven't heard of it LARS Relaxation
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.hs` to whatever you want your top-level module to
be called. Typically this is the same as your package name but in
`CamelCase` instead of `kebab-case`.
- Don't forget to rename the reference to it in
`executable/Main.hs`!
- If you are on an older version of Stack (<1.0.4), delete `package.yaml` and
remove `/*.cabal` from your `.gitignore`.
Once you've done that, start working on your project with the Stack commands
you know and love.
``` sh ``` sh
# Build the project. # Build the project.
...@@ -44,5 +17,3 @@ stack haddock ...@@ -44,5 +17,3 @@ stack haddock
``` ```
Thanks again, and happy hacking! Thanks again, and happy hacking!
[lars-relax]: https://github.com/githubuser/lars-relax
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment