summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-10-15 11:55:53 +0000
committerAylur <[email protected]>2024-10-15 11:55:53 +0000
commitfe11c037bad45697451b7264ff93fa37f1fac78f (patch)
treee84ae7a0bb789e7764005259fe3485e3a3462c49 /docs/guide
parentdde50e333a237efb4ddaf522398dedf1a69999d1 (diff)
docs: recommend /usr prefix by default
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/getting-started/installation.md14
-rw-r--r--docs/guide/libraries/apps.md18
-rw-r--r--docs/guide/libraries/auth.md13
-rw-r--r--docs/guide/libraries/battery.md13
-rw-r--r--docs/guide/libraries/bluetooth.md13
-rw-r--r--docs/guide/libraries/hyprland.md13
-rw-r--r--docs/guide/libraries/mpris.md13
-rw-r--r--docs/guide/libraries/network.md13
-rw-r--r--docs/guide/libraries/notifd.md13
-rw-r--r--docs/guide/libraries/powerprofiles.md13
-rw-r--r--docs/guide/libraries/references.md1
-rw-r--r--docs/guide/libraries/river.md13
-rw-r--r--docs/guide/libraries/tray.md13
-rw-r--r--docs/guide/libraries/wireplumber.md13
-rw-r--r--docs/guide/typescript/installation.md4
15 files changed, 15 insertions, 165 deletions
diff --git a/docs/guide/getting-started/installation.md b/docs/guide/getting-started/installation.md
index 6ad951a..96cbdfa 100644
--- a/docs/guide/getting-started/installation.md
+++ b/docs/guide/getting-started/installation.md
@@ -56,7 +56,7 @@ sudo apt install meson valac libgtk-3-dev libgtk-layer-shell-dev gobject-introsp
```sh
cd lib/astal/io
-meson setup build
+meson setup --prefix /usr build
meson install -C build
```
@@ -64,18 +64,6 @@ meson install -C build
```sh
cd lib/astal/gtk3
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
meson install -C build
```
-
-:::
diff --git a/docs/guide/libraries/apps.md b/docs/guide/libraries/apps.md
index c53daf0..7f9ee6e 100644
--- a/docs/guide/libraries/apps.md
+++ b/docs/guide/libraries/apps.md
@@ -33,21 +33,10 @@ cd astal/lib/apps
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Apps reference](https://aylur.github.io/libastal/apps).
@@ -106,8 +95,3 @@ end
```
:::
-
-:::info
-The fuzzy query uses [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance). I am not a mathematician, but if you know how to reimplement
-the logic of [fzf](https://github.com/junegunn/fzf) to make it better feel free to open PRs.
-:::
diff --git a/docs/guide/libraries/auth.md b/docs/guide/libraries/auth.md
index 1f07a17..d5f0a49 100644
--- a/docs/guide/libraries/auth.md
+++ b/docs/guide/libraries/auth.md
@@ -43,21 +43,10 @@ cd astal/lib/auth
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Auth reference](https://aylur.github.io/libastal/auth).
diff --git a/docs/guide/libraries/battery.md b/docs/guide/libraries/battery.md
index b42d747..7f94297 100644
--- a/docs/guide/libraries/battery.md
+++ b/docs/guide/libraries/battery.md
@@ -37,21 +37,10 @@ cd astal/lib/battery
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Battery reference](https://aylur.github.io/libastal/battery).
diff --git a/docs/guide/libraries/bluetooth.md b/docs/guide/libraries/bluetooth.md
index 04d9db2..672f66d 100644
--- a/docs/guide/libraries/bluetooth.md
+++ b/docs/guide/libraries/bluetooth.md
@@ -37,21 +37,10 @@ cd astal/lib/bluetooth
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Bluetooth reference](https://aylur.github.io/libastal/bluetooth).
diff --git a/docs/guide/libraries/hyprland.md b/docs/guide/libraries/hyprland.md
index faf9e50..672faad 100644
--- a/docs/guide/libraries/hyprland.md
+++ b/docs/guide/libraries/hyprland.md
@@ -32,21 +32,10 @@ cd astal/lib/hyprland
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Hyprland reference](https://aylur.github.io/libastal/hyprland).
diff --git a/docs/guide/libraries/mpris.md b/docs/guide/libraries/mpris.md
index dfe7956..4f8c017 100644
--- a/docs/guide/libraries/mpris.md
+++ b/docs/guide/libraries/mpris.md
@@ -36,21 +36,10 @@ cd astal/lib/mpris
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Mpris reference](https://aylur.github.io/libastal/mpris).
diff --git a/docs/guide/libraries/network.md b/docs/guide/libraries/network.md
index afeb5d2..e076950 100644
--- a/docs/guide/libraries/network.md
+++ b/docs/guide/libraries/network.md
@@ -32,21 +32,10 @@ cd astal/lib/network
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Network reference](https://aylur.github.io/libastal/network).
diff --git a/docs/guide/libraries/notifd.md b/docs/guide/libraries/notifd.md
index 7e02149..094b770 100644
--- a/docs/guide/libraries/notifd.md
+++ b/docs/guide/libraries/notifd.md
@@ -36,21 +36,10 @@ cd astal/lib/notifd
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Notifd reference](https://aylur.github.io/libastal/notifd).
diff --git a/docs/guide/libraries/powerprofiles.md b/docs/guide/libraries/powerprofiles.md
index 8571c29..159f3ff 100644
--- a/docs/guide/libraries/powerprofiles.md
+++ b/docs/guide/libraries/powerprofiles.md
@@ -37,21 +37,10 @@ cd astal/lib/powerprofiles
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [PowerProfiles reference](https://aylur.github.io/libastal/powerprofiles).
diff --git a/docs/guide/libraries/references.md b/docs/guide/libraries/references.md
index 8f2bd02..3a85d73 100644
--- a/docs/guide/libraries/references.md
+++ b/docs/guide/libraries/references.md
@@ -29,7 +29,6 @@ Reading their documentation will vary depending on the language they are used in
## Astal Libraries
-- [Astal](https://aylur.github.io/libastal): libastal the core library, which has the widgets and utilites
- [Apps](https://aylur.github.io/libastal/apps): Library and cli tool for querying applications
- [Auth](https://aylur.github.io/libastal/auth): Authentication library using PAM
- [Battery](https://aylur.github.io/libastal/battery): DBus proxy library for upower daemon
diff --git a/docs/guide/libraries/river.md b/docs/guide/libraries/river.md
index 4818d0b..299aa8c 100644
--- a/docs/guide/libraries/river.md
+++ b/docs/guide/libraries/river.md
@@ -32,21 +32,10 @@ cd astal/lib/river
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [River reference](https://aylur.github.io/libastal/river).
diff --git a/docs/guide/libraries/tray.md b/docs/guide/libraries/tray.md
index c8d093b..b5cccc7 100644
--- a/docs/guide/libraries/tray.md
+++ b/docs/guide/libraries/tray.md
@@ -32,21 +32,10 @@ cd astal/lib/tray
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Tray reference](https://aylur.github.io/libastal/tray).
diff --git a/docs/guide/libraries/wireplumber.md b/docs/guide/libraries/wireplumber.md
index 5f1daab..0592628 100644
--- a/docs/guide/libraries/wireplumber.md
+++ b/docs/guide/libraries/wireplumber.md
@@ -32,21 +32,10 @@ cd astal/lib/wireplumber
3. install
```sh
-meson setup build
-meson install -C build
-```
-
-:::tip
-Most distros recommend manual installs in `/usr/local`,
-which is what `meson` defaults to. If you want to install to `/usr`
-instead which most package managers do, set the `prefix` option:
-
-```sh
meson setup --prefix /usr build
+meson install -C build
```
-:::
-
## Usage
You can browse the [Wireplumber reference](https://aylur.github.io/libastal/wireplumber).
diff --git a/docs/guide/typescript/installation.md b/docs/guide/typescript/installation.md
index 4c31b6e..f085194 100644
--- a/docs/guide/typescript/installation.md
+++ b/docs/guide/typescript/installation.md
@@ -9,7 +9,7 @@ It lets you
- generate a tsconfig which is used by LSPs
- bundle your TypeScript and JavaScript code using [esbuild](https://esbuild.github.io/).
-::: details Trivia
+:::details Trivia
AGS is the predecessor of Astal, which was written purely in TypeScript and so only supported
JavaScript/TypeScript. Now it serves as a scaffolding tool for Astal+TypeScript+JSX projects.
:::
@@ -43,7 +43,7 @@ meson install -C build
:::tip
You might be wondering why it is recommended to install a JavaScript
package on the system instead of installing it as a node module.
-It is solely to keep it in **sync** with the core `astal-sh` and `astal3`/`astal4` package.
+It is solely to keep it in **sync** with the core `astal-io` and `astal3`/`astal4` package.
:::
3. Install the following dependencies