-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
Contributing
section to README.md
- Loading branch information
Showing
1 changed file
with
17 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,27 @@ | ||
# 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! | ||
|
||
## 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. |