From b04c0e960a34459d765322fac3ed50c4bcbea6df Mon Sep 17 00:00:00 2001 From: Lucas Bollen Date: Thu, 8 Feb 2024 13:33:40 +0100 Subject: [PATCH] Add `Contributing` section to `README.md` --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c27f4aa..223ba43 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Stack Templates -Templates for `stack new` command. If you wish to alter a template, edit them in `projects/` and run `./render.hs`. To instantiate one the projects: - +Templates for `stack new` command. To use this template perform the following steps: 1. [Install Stack](https://docs.haskellstack.org/en/stable/README/#how-to-install) 2. Run `stack new my-clash-project clash-lang/simple`. Replace `simple` by the template you'd like to use. 3. Read `my-clash-project/README.md`. Enjoy! @@ -8,5 +7,21 @@ Templates for `stack new` command. If you wish to alter a template, edit them in ## Cabal users All starter projects are also available on [clash-lang/clash-starters](https://github.com/clash-lang/clash-starters). +## Contributing +If you wish to contribute to this template, edit them in `projects/` and perform the following steps to test the template: +1. Edit the template +2. Run `./render.hs` to instantiate them. +3. Go to the parent directory: `cd ..` and instantiate the template using the rendered `.hsfiles`. +``` +cd .. +stack new my-template stack-templates/simple.hsfiles +``` +4. Use the template: +``` +cd my-template +cabal build +cabal test +``` + ## License The default license for each of the starter project is BSD2. However, this whole repository -including every starter project- is licensed under CC0. That means the authors, to the extent possible under law, have waived all copyright and related or neighboring rights to this "Clash Example Project". Feel free to choose any license for the starter projects that you want.