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: README.md
+15-3
Original file line number
Diff line number
Diff line change
@@ -79,8 +79,8 @@ A new package can be created using `psc-package init`. This will:
79
79
80
80
To add a dependency, either:
81
81
82
-
- Use the `install` command, which will update the project configuration automatically, or
83
-
- Modify the `psc-package.json` file, and sync manually by running the `update` command.
82
+
- Use the `install <package name>` command, which will update the project configuration automatically, or
83
+
- Modify the `psc-package.json` file, and sync manually by running the `install` command (previously `update`).
84
84
85
85
### Build a project
86
86
@@ -128,12 +128,24 @@ Then copy over `packages.json` into the directory:
128
128
129
129
If this builds correctly, you can then push up this branch and make a pull request. Travis will verify your package builds correctly, and then we will try to merge your pull request. Your package will then be available in the next tagged package set.
130
130
131
+
### Formatting the package set
132
+
133
+
When creating your pull request, make sure to run the `format` command to pretty-print the packages file. This helps us avoid problems in the future with git diffs and so on.
134
+
131
135
### Update a package in the set
132
136
133
137
Similar to the above, you will need to do the setup. You can then modify the version field to the version you wish to use. Once you have updated the package set, run the copy command and verify the package you have modified.
134
138
135
139
Then you can make a pull request. Again, once Travis verifies your change, we will merge it into `master` and your change will be available in the next tag.
136
140
141
+
### Add a package from Bower
142
+
143
+
If you have Bower installed on your system, you can easily add a package from Bower to the package set. Use the Bower package name to add the package using the `add-from-bower` command:
144
+
145
+
```
146
+
psc-package add-from-bower <purescript-something>
147
+
```
148
+
137
149
## FAQ
138
150
139
151
### Can I add a dependency which is not in the package set?
@@ -152,5 +164,5 @@ clear the cache for the changes to take effect.
0 commit comments