NaxdyOrg/niri
1
0
Fork 0
forked from Mirror/niri
Code Issues 4 Pull Requests Activity

chore(project): format markdowns

Browse Source
This commit is contained in:
Naxdy
2025-11-25 18:34:48 +01:00
parent 378009ae1d
commit 272de908b8
3 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/wiki/README.md
View File

@@ -1,15 +1,15 @@
Welcome to the niri documentation!
Feel free to look through usage and [Getting started](./Getting-Started.md).
If you're looking for ways to configure niri, check out the [introduction to configuration](./Configuration:-Introduction.md).
Feel free to look through usage and [Getting started](./Getting-Started.md). If you're looking for ways to configure
niri, check out the [introduction to configuration](./Configuration:-Introduction.md).
If you'd like to help with niri, there are plenty of both coding- and non-coding-related ways to do so.
See [CONTRIBUTING.md](https://github.com/YaLTeR/niri/blob/main/CONTRIBUTING.md) for an overview.
If you'd like to help with niri, there are plenty of both coding- and non-coding-related ways to do so. See
[CONTRIBUTING.md](https://github.com/YaLTeR/niri/blob/main/CONTRIBUTING.md) for an overview.
If you're not already here, check out our new wiki website! https://yalter.github.io/niri/
---
The documentation is open to contribution, see [Documenting niri](./Development:-Documenting-niri.md).
Please discuss bigger changes in [our Matrix room](https://matrix.to/#/#niri:matrix.org) first!
The wiki is generated from files in the `docs/wiki/` folder of the repository, so you can open a pull request modifying it there.
The documentation is open to contribution, see [Documenting niri](./Development:-Documenting-niri.md). Please discuss
bigger changes in [our Matrix room](https://matrix.to/#/#niri:matrix.org) first! The wiki is generated from files in the
`docs/wiki/` folder of the repository, so you can open a pull request modifying it there.

5
niri-ipc/README.md
View File

@@ -4,9 +4,8 @@ Types and helpers for interfacing with the [niri](https://github.com/YaLTeR/niri
## Backwards compatibility
This crate follows the niri version.
It is **not** API-stable in terms of the Rust semver.
In particular, expect new struct fields and enum variants to be added in patch version bumps.
This crate follows the niri version. It is **not** API-stable in terms of the Rust semver. In particular, expect new
struct fields and enum variants to be added in patch version bumps.
Use an exact version requirement to avoid breaking changes:

9
niri-visual-tests/README.md
View File

@@ -4,11 +4,10 @@
>
> This is a development-only app, you shouldn't package it.
This app contains a number of hard-coded test scenarios for visual inspection.
It uses the real niri layout and rendering code, but with mock windows instead of Wayland clients.
The idea is to go through the test scenarios and check that everything *looks* right.
This app contains a number of hard-coded test scenarios for visual inspection. It uses the real niri layout and
rendering code, but with mock windows instead of Wayland clients. The idea is to go through the test scenarios and check
that everything _looks_ right.
## Running
You will need recent GTK and libadwaita.
Then, `cargo run`.
You will need recent GTK and libadwaita. Then, `cargo run`.