Skip to content

Commit d9d72b4

Browse files
committed
Rework getting started guide to package description
1 parent 3561064 commit d9d72b4

18 files changed

+493
-384
lines changed

doc/other_resources.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,10 @@ There are lots of resources available for learning more about Stack:
1717
* The [haskell-stack tag on Stack Overflow](http://stackoverflow.com/questions/tagged/haskell-stack)
1818
* [Another getting started with Stack tutorial](http://seanhess.github.io/2015/08/04/practical-haskell-getting-started.html)
1919
* [Why is Stack not Cabal?](https://www.fpcomplete.com/blog/2015/06/why-is-stack-not-cabal)
20+
21+
Package description format specifications supported by Stack:
22+
23+
* Cabal's: a
24+
[Cabal file](https://cabal.readthedocs.io/en/stable/cabal-package-description-file.html)
25+
* Hpack's: a
26+
[`package.yaml` file](https://github.com/sol/hpack?tab=readme-ov-file#documentation)

doc/tutorial/building_existing_projects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://cdn.jsdelivr.net/gh/commercialhaskell/stack/doc/img/hidden-warning.svg"></a></div>
22

3-
# 3. Building existing projects
3+
# 5. Building existing projects
44

55
Alright, enough playing around with simple projects. Let's take an open source
66
package and try to build it. We'll be ambitious and use

doc/tutorial/building_your_project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://cdn.jsdelivr.net/gh/commercialhaskell/stack/doc/img/hidden-warning.svg"></a></div>
22

3-
# 2. Building your project
3+
# 4. Building your project
44

55
The [`stack build`](../commands/build_command.md) command is the heart of Stack.
66
It is the engine that powers building your code, testing it, getting

doc/tutorial/cabal_flags_and_ghc_options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://cdn.jsdelivr.net/gh/commercialhaskell/stack/doc/img/hidden-warning.svg"></a></div>
22

3-
# 8. Cabal flags and GHC options
3+
# 10. Cabal flags and GHC options
44

55
There are two common ways to alter how a package will install: with Cabal flags
66
and with GHC options.

doc/tutorial/executing_commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div class="hidden-warning"><a href="https://docs.haskellstack.org/"><img src="https://cdn.jsdelivr.net/gh/commercialhaskell/stack/doc/img/hidden-warning.svg"></a></div>
22

3-
# 10. Executing commands
3+
# 12. Executing commands
44

55
We've already used `stack exec` multiple times in this guide. As you've likely
66
already guessed, it allows you to run executables, but with a slightly modified

0 commit comments

Comments
 (0)