Skip to content

Commit 8abc716

Browse files
authored
Update 'Style Guide' to reflect Spago as recommended build tool (#297)
1 parent 441b16d commit 8abc716

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

guides/Style-Guide.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The PureScript core libraries are good examples of how to put these guidelines i
44

55
## Build Tools
66

7-
- Consider using a one-step build tool such as Pulp or `gulp-purescript` to make your build as simple as possible for end-users.
7+
- Consider using a one-step build tool such as [Spago](https://github.com/purescript/spago) to make your build as simple as possible for end-users.
88
- Document build steps for compilation, testing and documentation clearly in your `README` file.
99

1010
## Documentation
@@ -41,17 +41,16 @@ It was previously common to include Markdown documentation generated by `psc-doc
4141
sudo: required
4242
node_js: 6
4343
install:
44-
- npm install purescript pulp bower -g
45-
- bower install
44+
- npm install purescript spago -g
4645
script:
47-
- pulp build && pulp test
46+
- spago build && spago test
4847
```
4948
5049
- Display the Travis badge in your `README` file so that the build status is visible.
5150
5251
## Publishing
5352
54-
- Share your library on [Bower](http://bower.io/search/?q=purescript), prefixing the name of your library with `purescript-` so others can find your work.
53+
- Share your library on [Bower](http://bower.io/search/?q=purescript), prefixing the name of your library with `purescript-` so others can find your work.
5554
- Bower works with git tags, but does not require any present tags to publish. Please run `bower version 0.0.0` and push tags for your initial release (this prevents interim work not intended for publication from leaking on `0.0.0` libs).
5655
- Considering that you may need to be editing your library live as a part of the development of your main project, check out `bower link` (learn all about it [here](https://oncletom.io/2013/live-development-bower-component/)). This will enable you to keep the repos in sync as you work, and facilitate publishing when ready.
5756
- `bower link` can also be useful if you plan on contributing to a package needed by your project. Simply fork the repo, and link. Once you have your additional bindings, or features needed for your project working, you can contribute them back to the source repo easily with a Pull Request.
@@ -76,7 +75,7 @@ It was previously common to include Markdown documentation generated by `psc-doc
7675
## Foreign Function Interface
7776
7877
- PureScript is a new language, and has a need for high quality FFI libraries.
79-
- If you have already written a library that has FFI code into a native API, consider splitting it into two libraries, a barebones set of FFI bindings, and your extra functionality.
78+
- If you have already written a library that has FFI code into a native API, consider splitting it into two libraries, a barebones set of FFI bindings, and your extra functionality.
8079
8180
## Runtime Requirements
8281

0 commit comments

Comments
 (0)