Skip to content

Commit

Permalink
Merge pull request commercialhaskell#2143 from sjakobi/legal-packagen…
Browse files Browse the repository at this point in the history
…ames

Docs: Cite package name rules in section for `stack new`
  • Loading branch information
mgsloan committed May 16, 2016
2 parents 79673e7 + 4c85869 commit 98b1b84
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions doc/GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,18 @@ through the most common stack commands.

### stack new

We'll start off with the `stack new` command to create a new
*project*. We'll call our project `helloworld`, and we'll use the
`new-template` project template:
We'll start off with the `stack new` command to create a new *project*, that
will contain a Haskell *package* of the same name. So let's pick a valid
package name first:

> A package is identified by a globally-unique package name, which consists
of one or more alphanumeric words separated by hyphens. To avoid ambiguity,
each of these words should contain at least one letter.

(From the [Cabal users guide](https://www.haskell.org/cabal/users-guide/developing-packages.html#developing-packages))

We'll call our project `helloworld`, and we'll use the `new-template` project
template:

```
michael@d30748af6d3d:~$ stack new helloworld new-template
Expand Down

0 comments on commit 98b1b84

Please sign in to comment.