File tree Expand file tree Collapse file tree 4 files changed +8
-22
lines changed
Expand file tree Collapse file tree 4 files changed +8
-22
lines changed Original file line number Diff line number Diff line change 11# purescript-ags-bindings
22
3- WIP [ AGS] ( https://github.com/Aylur/ags/ ) bindings for PureScript.
3+ Low(ish)-level [ AGS] ( https://github.com/Aylur/ags/ ) bindings for PureScript.
44
55## Usage examples
66
77Standalone subprojects in the ` examples/ ` directory demonstrate how to use AGS with PureScript.
88Head over to [ ` examples/README.md ` ] ( examples/README.md ) for more information.
99
10- ## Development
10+ ## Usage
1111
12- #### 0. [ Optional] Load the Nix shell
13-
14- With flakes and ` direnv ` :
15-
16- ``` shell
17- > echo ' use flake' > .envrc
18- > direnv allow
19- ```
20-
21- With flakes:
22-
23- ``` shell
24- > nix develop
25- > exec $SHELL
26- ```
12+ This library can be used in different ways. An example setup would look as follows:
2713
2814#### 1. Add an entrypoint module
2915
@@ -51,11 +37,11 @@ export default { windows: main().windows }
5137#### 3. Run AGS
5238
5339``` shell
54- > ags --bus-name ags-dev - c ./entrypoint.js
40+ > ags -c ./entrypoint.js
5541```
5642
5743Or to run with GTK inspector:
5844``` shell
59- > ags --bus-name ags-dev - c ./entrypoint.js -i
45+ > ags -c ./entrypoint.js -i
6046```
6147
Original file line number Diff line number Diff line change 11# Examples directory
22
33Each subdirectory here is a standalone mini-project which demonstrates how to use ` purescript-ags-bindings ` .
4- To build a project, change into its directory, build it with Spago and bundle it with ` purs-backend-es ` .
4+ To build a project, change into its directory and build and bundle it with Spago .
55A sample entrypoint JS file is provided for reference as well.
66
77``` shell
Original file line number Diff line number Diff line change @@ -4,5 +4,5 @@ The launcher uses the default GTK theme with no extra styling and includes app i
44
55## Building
66
7- See building instructions in the parent directory's [ README.md] ( ../README.md )
7+ See building instructions in the parent directory's [ README.md] ( ../README.md ) .
88
Original file line number Diff line number Diff line change @@ -19,5 +19,5 @@ Dependencies for running this project consist of:
1919
2020### Building
2121
22- See building instructions in the parent directory's ` README.md `
22+ See building instructions in the parent directory's [ README.md] ( ../README.md ) .
2323
You can’t perform that action at this time.
0 commit comments