summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorKevin <[email protected]>2024-11-06 14:03:31 -0300
committerGitHub <[email protected]>2024-11-06 14:03:31 -0300
commit5217df934bcd17941139af484e478a2bce48a2f8 (patch)
tree848833c3659ded1b5c87c37011f836e653eb9f50 /docs/guide
parentb1da91dcced3803c764d22d4da1a49c23d7e97ed (diff)
parent84c02e54d3bd25958dafa67a7420cf29b3375de1 (diff)
Merge branch 'Aylur:main' into lua-refactor
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/libraries/greet.md94
-rw-r--r--docs/guide/typescript/cli-app.md4
-rw-r--r--docs/guide/typescript/first-widgets.md8
-rw-r--r--docs/guide/typescript/installation.md1
4 files changed, 100 insertions, 7 deletions
diff --git a/docs/guide/libraries/greet.md b/docs/guide/libraries/greet.md
new file mode 100644
index 0000000..f0cd012
--- /dev/null
+++ b/docs/guide/libraries/greet.md
@@ -0,0 +1,94 @@
+# Greet
+
+Library and CLI tool for sending requests to [greetd](https://sr.ht/~kennylevinsen/greetd/).
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libjson-glib-dev gobject-introspection
+```
+
+:::
+
+::: info
+Although `greetd` is not a direct build dependency,
+it should be self-explanatory that the daemon is required to be available at runtime.
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/greet
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
+
+## Usage
+
+You can browse the [Greet reference](https://aylur.github.io/libastal/greet).
+
+### CLI
+
+```sh
+astal-greet --help
+```
+
+### Library
+
+:::code-group
+
+```js [<i class="devicon-javascript-plain"></i> JavaScript]
+import Greet from "gi://AstalGreet"
+
+Greet.login("username", "password", "compositor", (_, res) => {
+ try {
+ Greet.login_finish(res)
+ } catch (err) {
+ printerr(err)
+ }
+})
+```
+
+```py [<i class="devicon-python-plain"></i> Python]
+# Not yet documented
+
+```
+
+```lua [<i class="devicon-lua-plain"></i> Lua]
+local Greet = require("lgi").require("AstalGreet")
+
+Greet.login("username", "password", "compositor", function (_, res)
+ local err = Greet.login_finish(res)
+ if err ~= nil then
+ print(err)
+ end
+end)
+```
+
+```vala [<i class="devicon-vala-plain"></i> Vala]
+try {
+ yield AstalGreet.login("username", "password", "compositor");
+} catch (Error err) {
+ printerr(err.message);
+}
+```
+
+:::
diff --git a/docs/guide/typescript/cli-app.md b/docs/guide/typescript/cli-app.md
index f409176..85b117c 100644
--- a/docs/guide/typescript/cli-app.md
+++ b/docs/guide/typescript/cli-app.md
@@ -61,7 +61,7 @@ astal say hi
```
```sh [ags]
-ags -m "say hi"
+ags request "say hi"
# hi cli
```
@@ -135,7 +135,7 @@ astal -t Bar
```
```sh [ags]
-ags -t Bar
+ags toggle Bar
```
:::
diff --git a/docs/guide/typescript/first-widgets.md b/docs/guide/typescript/first-widgets.md
index a7372a8..96a1275 100644
--- a/docs/guide/typescript/first-widgets.md
+++ b/docs/guide/typescript/first-widgets.md
@@ -5,13 +5,13 @@
Start by initializing a project
```sh
-ags --init
+ags init
```
-then run `ags` in the terminal
+then run `ags run` in the terminal
```sh
-ags
+ags run
```
:::details Usage without AGS
@@ -363,7 +363,7 @@ by setting `noImplicityDestroy` property on the container widget.
:::info
The above example destroys and recreates every widget in the list **every time**
the value of the `Variable` changes. There might be cases where you would
-want to [handle child creation and deletion](/guide/typescript/faq#avoiding-unnecessary-re-rendering)
+want to handle child creation and deletion
yourself, because you don't want to lose the
inner state of widgets that does not need to be recreated. In this case
you can create a [custom reactive structure](./binding#example-custom-subscribable)
diff --git a/docs/guide/typescript/installation.md b/docs/guide/typescript/installation.md
index f1d20c5..e0f1bd5 100644
--- a/docs/guide/typescript/installation.md
+++ b/docs/guide/typescript/installation.md
@@ -71,7 +71,6 @@ sudo apt install golang-go npm gjs
git clone https://github.com/aylur/ags.git /tmp/ags
cd /tmp/ags
git checkout v2 # https://github.com/Aylur/ags/pull/504
-cd src
go install
```