01. Overview & Architecture

Profile: 0.11.89
Schema validatedSource pinned
Purpose
Simple, minimalist dock for X11 desktops.
Compatibility
Any distro (Server: X11)
Desktop Part
Docks
Window Manager & Theme
Any WM / DE / Other

02. Installation & Deployment

Before you installThis changes your desktop configuration and installs packages. Run it as your normal user, never with sudo: it asks for sudo only where a step needs it (listed below).The guided installer shows its plan first. Files it would replace are kept unless you approve. Everything it copies, clones or appends to in your home folder is backed up and verified first, and --rollback restores it. Packages, sudo changes and the other commands listed under Impact are not undone.
IntegrityEach release from main builds the installers in GitHub Actions and signs them with a GitHub build attestation. Verify your download against the repository, not this website (Option B, step 2). If it does not verify, don't run it.
ImpactPackages: plank
RecoveryGuided: backups in ~/.local/state/0xtsoa/backups/, undo with bash install.sh --rollback.Manual: the steps below only write in the download folder or run listed commands.
Option A: manual installAdvanced
Read the source at the reviewed commit, back up, then run each step yourself.
$git clone https://github.com/ricotz/plank ~/0xtsoa-review/ricotz-plank# 1. clone to a review folder
$git -C ~/0xtsoa-review/ricotz-plank checkout --detach 396b87108a798912baa06db3e7bfe9862189c39b# 2. the reviewed commit
Then the steps. Package commands are written for Arch; on other distros use your package manager.

Step-by-step deployment protocol

Step-by-step deployment
1Install plank (Arch repos)
$sudo pacman -S --needed plank
$# Other distros: see the upstream README
Option B: guided installerRecommended
The same steps as one script for any distro. It shows the plan first, keeps files you already have unless you approve replacing them, and backs up everything it changes in your home folder. Never pipe it into a shell.
$curl -fsSLo install.sh 'https://www.0xtsoa.dev/configs/ricotz/plank/install.sh'# 1. download
$gh attestation verify install.sh --repo nyharena25/0xTsoa --signer-workflow nyharena25/0xTsoa/.github/workflows/attest-installers.yml# 2. verify (GitHub CLI 2.49+, signed in)
$less install.sh# 3. read it
$bash install.sh --dry-run# 4. preview: changes nothing
$bash install.sh# 5. install (asks first)
$bash install.sh --rollback# undo the file changes
View script in browserOther options: --force (replace conflicts, backed up first), --yes, --help

03. Documentation & Guide

Source: ricotz/plankRef: 396b87108a
README.md|GitHub Flavored Markdown
What Is Plank?

Plank is meant to be the simplest dock on the planet. The goal is to provide
just what a dock needs and absolutely nothing more. It is, however, a library
which can be extended to create other dock programs with more advanced features.

(Codenames for releases are currently based on characters of "Ed, Edd n Eddy".)


Reporting Bugs

You can report bugs here: https://bugs.launchpad.net/plank
Please try and avoid making duplicate bugs - search for existing bugs before
reporting a new bug!
You also might want to jump on our IRC channel (see below)


Where Can I Get Help?

IRC: #plank on FreeNode - irc://irc.freenode.net/#plank
Common problems and solutions
https://answers.launchpad.net/plank


How Can I Get Involved?

Visit the Launchpad page: https://launchpad.net/plank
Help translate: https://translations.launchpad.net/plank
Answer questions: https://answers.launchpad.net/plank


Are there online API documentations?

http://people.ubuntu.com/~ricotz/docs/vala-doc/plank/index.htm


Need more information about Vala?

https://wiki.gnome.org/Projects/Vala
https://wiki.gnome.org/Projects/Vala/Manual


Refer to the HACKING file for further instructions.

GitHub Flavored Markdown (github-markdown-css)README snapshot at 396b87108a