yogsototh/stack
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #2143 from sjakobi/legal-packagenames

Browse source 
Docs: Cite package name rules in section for `stack new`
This commit is contained in:
Michael Sloan 2016-05-15 20:34:56 -07:00
commit 98b1b848cd
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/GUIDE.md
View file

@ -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