From 65654282a98cb0590d498e4ed9c924f97646f1dc Mon Sep 17 00:00:00 2001 From: Aylur Date: Wed, 25 Sep 2024 23:22:01 +0000 Subject: docs: restructure --- docs/libraries/network.md | 94 ----------------------------------------------- 1 file changed, 94 deletions(-) delete mode 100644 docs/libraries/network.md (limited to 'docs/libraries/network.md') diff --git a/docs/libraries/network.md b/docs/libraries/network.md deleted file mode 100644 index afeb5d2..0000000 --- a/docs/libraries/network.md +++ /dev/null @@ -1,94 +0,0 @@ -# Network - -Wrapper library over [networkmanager](https://networkmanager.dev/) to better integrate with Astal. - -## Installation - -1. install dependencies - -:::code-group - -```sh [ Arch] -sudo pacman -Syu meson vala libnm gobject-introspection -``` - -```sh [ Fedora] -sudo dnf install meson gcc valac NetworkManager-libnm-devel gobject-introspection-devel -``` - -```sh [ Ubuntu] -sudo apt install meson valac libnm-dev gobject-introspection -``` - -::: - -2. clone repo - -```sh -git clone https://github.com/aylur/astal.git -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 -``` - -::: - -## Usage - -You can browse the [Network reference](https://aylur.github.io/libastal/network). - -### CLI - -There is no CLI for this library, use the one provided by networkmanager. - -```sh -nmcli --help -``` - -### Library - -:::code-group - -```js [ JavaScript] -import Network from "gi://AstalNetwork" - -const network = Network.get_default() - -print(network.wifi.ssid) -``` - -```py [ Python] -from gi.repository import AstalNetwork as Network - -network = Network.get_default() - -print(network.get_wifi().get_ssid()) -``` - -```lua [ Lua] -local Network = require("lgi").require("AstalNetwork") - -local network = Network.get_default() - -print(network.wifi.ssid) -``` - -```vala [ Vala] -// Not yet documented -``` - -::: -- cgit v1.2.3