Skip to content

Commit 1046c12

Browse files
alanzAvi-D-coder
authored andcommitted
Add some documentation
1 parent 206da46 commit 1046c12

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -726,6 +726,15 @@ This project is not started from scratch:
726726
- Fork this repo and hack as much as you can.
727727
- Ask @alanz or @hvr to join the project.
728728

729+
### Hacking on haskell-ide-engine
730+
731+
Haskell-ide-engine can be used on its own project. We have supplied
732+
preset samples of `hie.yaml` files for stack and cabal, simply copy
733+
the appropriate template to `hie.yaml` and it shoule work.
734+
735+
- `hie.yaml.cbl` for cabal
736+
- `hie.yaml.stack` for stack
737+
729738
## Documentation
730739

731740
All the documentation is in [the docs folder](/docs) at the root of this project.

hie.yaml.cbl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# This is a sample hie.yaml file for opening haskell-ide-engine in
2+
# hie, using cabal as the build system.
3+
# To use is, copy it to a file called 'hie.yaml'
4+
15
cradle:
26
cabal:
37
- path: "./hie-plugin-api/Haskell"

hie.yaml.stack

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# This is a sample hie.yaml file for opening haskell-ide-engine in
2+
# hie, using stack as the build system.
3+
# To use is, copy it to a file called 'hie.yaml'
4+
15
cradle:
26
stack:
37
- path: "./hie-plugin-api/"

0 commit comments

Comments
 (0)