You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/Style-Guide.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ The PureScript core libraries are good examples of how to put these guidelines i
4
4
5
5
## Build Tools
6
6
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.
8
8
- Document build steps for compilation, testing and documentation clearly in your `README` file.
9
9
10
10
## Documentation
@@ -41,17 +41,16 @@ It was previously common to include Markdown documentation generated by `psc-doc
41
41
sudo: required
42
42
node_js: 6
43
43
install:
44
-
- npm install purescript pulp bower -g
45
-
- bower install
44
+
- npm install purescript spago -g
46
45
script:
47
-
- pulp build && pulp test
46
+
- spago build && spago test
48
47
```
49
48
50
49
- Display the Travis badge in your `README` file so that the build status is visible.
51
50
52
51
## Publishing
53
52
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.
55
54
- 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).
56
55
- 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.
57
56
- `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
76
75
## Foreign Function Interface
77
76
78
77
- 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.
0 commit comments