From 4415cca2fe8b1c89b0d77a9700a01c3ff72d9f23 Mon Sep 17 00:00:00 2001 From: javalsai Date: Sat, 7 Sep 2024 16:28:05 +0200 Subject: [PATCH] docs: upate index --- INSTALL.md | 16 ++++++++-------- README.md | 32 +++++++++++++++----------------- 2 files changed, 23 insertions(+), 25 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index d89c9f8..a9c2f02 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,11 +1,11 @@ # Index -* [Index](#index) -* [Installing from Source](#installing-from-source) -* [AUR](#aur) -* [Nix Flake](#nix-flake) +- [Index](#index) +- [Installing from Source](#installing-from-source) +- [AUR](#aur) +- [Nix Flake](#nix-flake) -> \[!CAUTION] +> [!CAUTION] > I encourage you to read the manual installation steps to understand what will get installed in your computer by this package. # Installing from Source @@ -20,7 +20,7 @@ cd lidm make # 👍 ``` -> \[!NOTE] +> [!NOTE] > There's pre-built binaries on the [releases tab](https://github.com/javalsai/lidm/releases) too. Then you can install the files onto your filesystem with: @@ -48,7 +48,7 @@ make install-service-s6 # s6 [AUR packages](https://aur.archlinux.org/packages?K=lidm\&SeB=n) will automatically install most files. -> \[!CAUTION] +> [!CAUTION] > [service files](./assets/pkg/aur#services) have to be manually installed by now. # Nix Flake @@ -65,5 +65,5 @@ or try it out without installing by: nix run github:javalsai/lidm ``` -> \[!CAUTION] +> [!CAUTION] > This doesn't include [service files](./assets/pkg/aur#services) neither diff --git a/README.md b/README.md index 5955fce..07e2a93 100644 --- a/README.md +++ b/README.md @@ -39,22 +39,20 @@ LiDM is like any [X Display Manager](https://en.wikipedia.org/wiki/X_display_man # Index -* [LiDM](#lidm) - * [Features](#features) - * [WIP](#wip) -* [Index](#index) -* [Ideology](#ideology) -* [Usage](#usage) - * [Arguments](#arguments) - * [Program](#program) -* [Requirements](#requirements) -* [Installation](#installation) - * [Manually](#manually) - * [AUR](#aur) -* [Configuring](#configuring) -* [Contributing](#contributing) -* [Backstory](#backstory) -* [Contributors](#contributors) +- [LiDM](#lidm) + - [Features](#features) + - [WIP](#wip) +- [Index](#index) +- [Ideology](#ideology) +- [Usage](#usage) + - [Arguments](#arguments) + - [Program](#program) +- [Requirements](#requirements) +- [Installation](#installation) +- [Configuring](#configuring) +- [Contributing](#contributing) +- [Backstory](#backstory) +- [Contributors](#contributors) # Ideology @@ -100,7 +98,7 @@ Configured colors are just gonna be put inside `\x1b[...m`, ofc you can add an ' The default fg style should disable decorators set up in other elements (cursive, underline... it's just adding 20 to the number btw, so if cursive is 4 (iirc), disabling it is 24). -> \[!TIP] +> [!TIP] > If you don't like seeing an element, you can change the fg color of it to be the same as the bg, making it invisible. # Contributing