Skip to content

Commit 9d89358

Browse files
committed
update development.md
1 parent abe1ce1 commit 9d89358

File tree

3 files changed

+23
-11
lines changed

3 files changed

+23
-11
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ Usage of this library is documented in `Language.Purescript.Bridge`, with `write
9696

9797
There is an example; see `./example/readme.md`.
9898

99+
Also see `./development.md`.
100+
99101
## Status
100102

101103
It works for my use case and is used in production. PRs for more `PSType`s definitions and bridges are very welcome!

development.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
# Regenerate everything
2-
reset && stack run generate-purescript && mv src/Argonaut/* example/src/Argonaut && mv src/JsonHelpers/* example/src/JsonHelpers; cd example && spago bundle --bundle-type app --outfile static/index.js; cd ..
1+
# Development
32

4-
# Regenerate purescript files
5-
reset && cd example && spago bundle --bundle-type app --outfile static/index.js; cd ..
3+
## Example
4+
See `example/readme.md`
65

7-
# Roundtrip server example
6+
## Spago
7+
All PureScript code can be built from the root of the repository.
8+
*Required*: Spago 0.93.44+
89

9-
## Tab 1
10-
stack run example
10+
## Integration tests
1111

12-
## Tab 2
13-
cd example/static
14-
parcel serve index.html
12+
Run `cabal test` in the root of the repository.
13+
14+
This includes:
15+
* unit tests
16+
* Round Trip integration tests for two libraries
17+
* json-helpers
18+
* argonaut-aeson-generic
19+
20+
## Nix Flake
21+
22+
*All requirements* (including Spago, Cabal, GHC) to build and test the library are provided in the Nix Flake.
23+
24+
Enter the development shell via `nix develop`.

example/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ On page load, the client:
1818
## Nix
1919
The `nix develop` shell will provide PureScript 0.15 and Spago.
2020
## Without Nix
21-
You must install PureScript 0.15 and [spago-legacy](https://github.com/purescript/spago-legacy).
21+
You must install PureScript 0.15 and [spago-next](https://github.com/purescript/spago).
2222

2323
# Running the example
2424
- Enter the `example` directory

0 commit comments

Comments
 (0)