Skip to content

Commit

Permalink
Ammend some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
postsolar committed Feb 18, 2024
1 parent a56f1b3 commit 2da1070
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 22 deletions.
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,15 @@
# purescript-ags-bindings

WIP [AGS](https://github.com/Aylur/ags/) bindings for PureScript.
Low(ish)-level [AGS](https://github.com/Aylur/ags/) bindings for PureScript.

## Usage examples

Standalone subprojects in the `examples/` directory demonstrate how to use AGS with PureScript.
Head over to [`examples/README.md`](examples/README.md) for more information.

## Development
## Usage

#### 0. [Optional] Load the Nix shell

With flakes and `direnv`:

```shell
> echo 'use flake' > .envrc
> direnv allow
```

With flakes:

```shell
> nix develop
> exec $SHELL
```
This library can be used in different ways. An example setup would look as follows:

#### 1. Add an entrypoint module

Expand Down Expand Up @@ -51,11 +37,11 @@ export default { windows: main().windows }
#### 3. Run AGS

```shell
> ags --bus-name ags-dev -c ./entrypoint.js
> ags -c ./entrypoint.js
```

Or to run with GTK inspector:
```shell
> ags --bus-name ags-dev -c ./entrypoint.js -i
> ags -c ./entrypoint.js -i
```

2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Examples directory

Each subdirectory here is a standalone mini-project which demonstrates how to use `purescript-ags-bindings`.
To build a project, change into its directory, build it with Spago and bundle it with `purs-backend-es`.
To build a project, change into its directory and build and bundle it with Spago.
A sample entrypoint JS file is provided for reference as well.

```shell
Expand Down
2 changes: 1 addition & 1 deletion examples/app-launcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ The launcher uses the default GTK theme with no extra styling and includes app i

## Building

See building instructions in the parent directory's [README.md](../README.md)
See building instructions in the parent directory's [README.md](../README.md).

2 changes: 1 addition & 1 deletion examples/simple-bar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ Dependencies for running this project consist of:

### Building

See building instructions in the parent directory's `README.md`
See building instructions in the parent directory's [README.md](../README.md).

0 comments on commit 2da1070

Please sign in to comment.