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 1
1
# purescript-ags-bindings
2
2
3
- WIP [ AGS] ( https://github.com/Aylur/ags/ ) bindings for PureScript.
3
+ Low(ish)-level [ AGS] ( https://github.com/Aylur/ags/ ) bindings for PureScript.
4
4
5
5
## Usage examples
6
6
7
7
Standalone subprojects in the ` examples/ ` directory demonstrate how to use AGS with PureScript.
8
8
Head over to [ ` examples/README.md ` ] ( examples/README.md ) for more information.
9
9
10
- ## Development
10
+ ## Usage
11
11
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:
27
13
28
14
#### 1. Add an entrypoint module
29
15
@@ -51,11 +37,11 @@ export default { windows: main().windows }
51
37
#### 3. Run AGS
52
38
53
39
``` shell
54
- > ags --bus-name ags-dev - c ./entrypoint.js
40
+ > ags -c ./entrypoint.js
55
41
```
56
42
57
43
Or to run with GTK inspector:
58
44
``` shell
59
- > ags --bus-name ags-dev - c ./entrypoint.js -i
45
+ > ags -c ./entrypoint.js -i
60
46
```
61
47
Original file line number Diff line number Diff line change 1
1
# Examples directory
2
2
3
3
Each 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 .
5
5
A sample entrypoint JS file is provided for reference as well.
6
6
7
7
``` 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
4
4
5
5
## Building
6
6
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 ) .
8
8
Original file line number Diff line number Diff line change @@ -19,5 +19,5 @@ Dependencies for running this project consist of:
19
19
20
20
### Building
21
21
22
- See building instructions in the parent directory's ` README.md `
22
+ See building instructions in the parent directory's [ README.md] ( ../README.md ) .
23
23
You can’t perform that action at this time.
0 commit comments