Skip to content

Commit

Permalink
docs: Just implement #228, add slashes where needed.
Browse files Browse the repository at this point in the history
  • Loading branch information
CelticBoozer committed Oct 4, 2024
1 parent 104f736 commit df31337
Show file tree
Hide file tree
Showing 23 changed files with 104 additions and 102 deletions.
2 changes: 1 addition & 1 deletion .config/OpenRGB/.github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

I use a keyboard and mouse from a manufacturer that unfortunately does not make
software for Linux based systems. So I use the excellent
[OpenRGB](https://github.com/CalcProgrammer1/OpenRGB) solution, with
[OpenRGB](https://github.com/CalcProgrammer1/OpenRGB/) solution, with
[Effects Plugin](https://openrgb.org/plugins.html) to control the backlighting
of the devices.

Expand Down
4 changes: 2 additions & 2 deletions .config/bat/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# bat

bat is a nice modern replacement for cat, which supports syntax highlighting
and is generally much nicer to work with.
[bat](https://github.com/sharkdp/bat) is a nice modern replacement for cat,
which supports syntax highlighting and is generally much nicer to work with.

Use the **cat** alias to invoke this command.

Expand Down
2 changes: 1 addition & 1 deletion .config/btop/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# btop

[btop](https://github.com/aristocratos/btop) is an improved version of top.
[btop](https://github.com/aristocratos/btop/) is an improved version of top.
This utility allows me to control processes in my system and monitor its state
quite conveniently.

Expand Down
2 changes: 1 addition & 1 deletion .config/easyeffects/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EasyEfects

[EasyEffects](https://github.com/wwmm/easyeffects) is a powerful audio processing
[EasyEffects](https://github.com/wwmm/easyeffects/) is a powerful audio processing
application, allows users to apply various effects.

You can run it by right click on the sound module on the waybar.
2 changes: 1 addition & 1 deletion .config/kitty/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# kitty

[kitty](https://github.com/kovidgoyal/kitty) is a terminal emulator, it is
[kitty](https://github.com/kovidgoyal/kitty/) is a terminal emulator, it is
extremely fast, convenient, customizable. The most important thing for me is
that it supports tabs, tiles and image preview. Also this emulator is fully
customizable.
Expand Down
2 changes: 1 addition & 1 deletion .config/mako/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mako

[mako](https://github.com/emersion/mako). It is a fast and lightweight notification
[mako](https://github.com/emersion/mako/). It is a fast and lightweight notification
daemon. However, at the moment I have given up on mako due to low functionality,
in particular the lack of a notification center.

Expand Down
2 changes: 1 addition & 1 deletion .config/paru/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# paru

[paru](https://github.com/Morganamilo/paru) is an AUR helper for Arch Linux,
[paru](https://github.com/Morganamilo/paru/) is an AUR helper for Arch Linux,
used to easily install, manage, and update packages from both the official
repositories and the AUR. It is a modern, Rust-based alternative to other AUR
helpers like yay, with additional features like improved performance and more
Expand Down
10 changes: 5 additions & 5 deletions .config/rofi/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# rofi

[rofi](https://github.com/davatorium/rofi) is a lightweight, highly customizable
[rofi](https://github.com/davatorium/rofi/) is a lightweight, highly customizable
application launcher. It allows users to quickly search and launch applications,
and execute custom commands from a simple, searchable menu interface.

Unfortunately, the original rofi doesn't support Wayland. Therefore, I use the
[Wayland fork](https://github.com/lbonn/rofi).
[Wayland fork](https://github.com/lbonn/rofi/).

![rofi](rofi.png "rofi")

## Modes

- [rofi-calc](https://github.com/svenstaro/rofi-calc) is rofi's mode as a
- [rofi-calc](https://github.com/svenstaro/rofi-calc/) is rofi's mode as a
regular calculator. ![rofi-calc](rofi-calc.png "rofi-calc")
- [rofi-cliphist](https://github.com/sentriz/cliphist) is rofi's mode as a
- [rofi-cliphist](https://github.com/sentriz/cliphist/) is rofi's mode as a
clipboard manager with image support.
![rofi-cliphist](rofi-cliphist.png "rofi-cliphist")
- rofi-drun is rofi's mode as an application launcher.
![rofi-drun](rofi-drun.png "rofi-drun")
- [rofi-power-menu](https://github.com/jluttine/rofi-power-menu) is rofi's mode
- [rofi-power-menu](https://github.com/jluttine/rofi-power-menu/) is rofi's mode
as a power manager.
![rofi-power-menu](rofi-power-menu.png "rofi-power-menu")
4 changes: 2 additions & 2 deletions .config/swappy/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Swappy

[Swappy](https://github.com/jtheoof/swappy) is a great, Wayland native snapshot
and editor tool. It works with [grim](https://github.com/emersion/grim).
[Swappy](https://github.com/jtheoof/swappy/) is a great, Wayland native snapshot
and editor tool. It works with [grim](https://github.com/emersion/grim/).

You can run it via the hotkeys:

Expand Down
2 changes: 1 addition & 1 deletion .config/sway/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sway

[Sway](https://github.com/swaywm/sway) Window Manager is a tiling window manager
[Sway](https://github.com/swaywm/sway/) Window Manager is a tiling window manager
and a drop-in replacement for i3, built specifically for the Wayland display
server. I chose it because of: lightweight, tiling, customization, minimalizm.

Expand Down
2 changes: 1 addition & 1 deletion .config/swayidle/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# swayidle

[swayidle](https://github.com/swaywm/swayidle) is a daemon for managing idle
[swayidle](https://github.com/swaywm/swayidle/) is a daemon for managing idle
states in the SwayWM. It allows to define actions that trigger after a set
period of inactivity, such as locking the screen, dimming the display, or
suspending the system.
Expand Down
6 changes: 3 additions & 3 deletions .config/swaylock/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# swaylock

[swaylock](https://github.com/swaywm/swaylock) is a screen locker for the SwayWM.
[swaylock](https://github.com/swaywm/swaylock/) is a screen locker for the SwayWM.
It locks the screen, requiring the to enter password to unlock it.

Unfortunately, the original project doesn't support screenshots and dimming.
That's why I chose [swaylock-effect](https://github.com/mortie/swaylock-effects),
That's why I chose [swaylock-effect](https://github.com/mortie/swaylock-effects/),
however this project was abandoned by the author, so I'm using a
[supported fork](https://github.com/jirutka/swaylock-effects).
[supported fork](https://github.com/jirutka/swaylock-effects/).

To execute swaylock use hotkey Win+Esc.

Expand Down
4 changes: 2 additions & 2 deletions .config/swaync/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# SwayNC

[SwayNC](https://github.com/ErikReider/SwayNotificationCenter) - is a notification
[SwayNC](https://github.com/ErikReider/SwayNotificationCenter/) - is a notification
center and daemon designed specifically for the Sway window manager and other
Wayland-based environments. It's pretty lightweight, fast, and functional. Its
main advantage is the availability of a full-fledged notification center.

> As an alternative to SwayNC you can use my configuration for
[mako](https://github.com/CelticBoozer/dotfiles/tree/master/.config/mako).
[mako](https://github.com/CelticBoozer/dotfiles/tree/master/.config/mako/).

![SwayNC notification](notification.png "Notification example")

Expand Down
2 changes: 1 addition & 1 deletion .config/sworkstyle/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# sworkstyle

[sworkstyle](https://github.com/Lyr-7D1h/swayest_workstyle) - a beautiful project
[sworkstyle](https://github.com/Lyr-7D1h/swayest_workstyle/) - a beautiful project
that maps workspace and icons of programs that are located on it.

![sworkstyle](sworkstyle.png "sworkstyle")
13 changes: 7 additions & 6 deletions .config/waybar/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Waybar

The default status bar for Sway - 'swaybar' although quite minimalistic and
lightweight, is very limited and low-functional. That's why I've chosen [waybar](https://github.com/Alexays/Waybar)
as an alternative. Waybar is a more advanced status bar that offers extensive
customization options and additional features.
lightweight, is very limited and low-functional. That's why I've chosen
[waybar](https://github.com/Alexays/Waybar/) as an alternative. Waybar is a
more advanced status bar that offers extensive customization options and
additional features.

I tried to style the waybar to look like the vim-airline plugin.

Expand All @@ -13,11 +14,11 @@ Most of the modules I use are standard modules and you can read information
about them in the official waybar documentation. However, below you can see
a list of custom modules.

- [waybar-crypto](https://github.com/Chadsr/waybar-crypto) - displays the price
- [waybar-crypto](https://github.com/Chadsr/waybar-crypto/) - displays the price
of cryptocurrencies directly on the bar.
- [wttrbar](https://github.com/bjesus/wttrbar) - displays the current weather,
- [wttrbar](https://github.com/bjesus/wttrbar/) - displays the current weather,
it uses information from wttr.in.
- [pacman-updates](https://github.com/coffebar/waybar-module-pacman-updates) -
- [pacman-updates](https://github.com/coffebar/waybar-module-pacman-updates/) -
displays the number of packages for which an update has appeared.

## Behavior
Expand Down
8 changes: 4 additions & 4 deletions .config/wob/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# wob

[wob](https://github.com/francma/wob) overlay volume/backlight/progress/anything
[wob](https://github.com/francma/wob/) overlay volume/backlight/progress/anything
bar for wlroots. It's fast and lightweight, but it doesn't support keystroke
events, only volume and brightness changes. So I stopped using it and switched
to SwayOSD. However, you can still use my configuration for wob.

![wob](wob.png "wob")

> [SwayOSD](https://github.com/ErikReider/SwayOSD) provides on-screen display (OSD)
notifications for various events, f.e. volume and brightness changes, Caps Lock
status changes etc.
> [SwayOSD](https://github.com/ErikReider/SwayOSD/) provides on-screen display
(OSD) notifications for various events, f.e. volume and brightness changes,
Caps Lock status changes etc.

![swayosd](swayosd.png "SwayOSD")
5 changes: 3 additions & 2 deletions .config/yazi/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# yazi

yazi is an awesome file manager. Fast, similar to vim, beautiful, easy to
customize. That's why I chose it as my primary file manager.
[yazi](https://github.com/sxyazi/yazi/) is an awesome file manager. Fast, similar
to vim, beautiful, easy to customize. That's why I chose it as my primary file
manager.

![yazi](yazi.png "yazi")

Expand Down
2 changes: 1 addition & 1 deletion .config/zathura/.github/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# zathura

[zathura](https://github.com/pwmt/zathura) is a lightweight, customizable PDF
[zathura](https://github.com/pwmt/zathura/) is a lightweight, customizable PDF
viewer for Linux that operates in the terminal and uses a minimalist,
keyboard-driven interface. It supports various document formats like PDF,
PostScript, and DjVu through plugins, and is designed to integrate well with
Expand Down
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,4 @@ the community.
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/),
version [1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md)
and [2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen/).
18 changes: 9 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,16 @@ unacceptable behavior to <celtic.boozer@proton.me>.

## I Have a Question

Before you ask a question, it is best to search for existing [Issues](https://github.com/CelticBoozer/dotfiles/issues)
and [Discussions](https://github.com/CelticBoozer/dotfiles/discussions)
Before you ask a question, it is best to search for existing [Issues](https://github.com/CelticBoozer/dotfiles/issues/)
and [Discussions](https://github.com/CelticBoozer/dotfiles/discussions/)
that might help you. In case you have found a suitable issue or discussion and
still need clarification, you can write your question in this issue. It is also
advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we
recommend the following:

- Open new or join existing an [Discussions](https://github.com/CelticBoozer/dotfiles/discussions).
- Open new or join existing an [Discussions](https://github.com/CelticBoozer/dotfiles/discussions/).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (lua, neovim, etc), depending on what
seems relevant.
Expand Down Expand Up @@ -127,15 +127,15 @@ and the community to understand your suggestion and find related suggestions.
- Read the [README](https://github.com/CelticBoozer/dotfiles/blob/master/.github/README.md)
carefully and find out if the functionality is already covered, maybe by an
individual configuration.
- Perform a search in [Issues](https://github.com/CelticBoozer/dotfiles/issues)
and [Discussions](https://github.com/CelticBoozer/dotfiles/discussions)
- Perform a search in [Issues](https://github.com/CelticBoozer/dotfiles/issues/)
and [Discussions](https://github.com/CelticBoozer/dotfiles/discussions/)
to see if the enhancement has already been suggested. If it has, add a comment
to the existing issue instead of opening a new one.

#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://github.com/CelticBoozer/dotfiles/issues)
and [Discussions](https://github.com/CelticBoozer/dotfiles/discussions).
Enhancement suggestions are tracked as [GitHub issues](https://github.com/CelticBoozer/dotfiles/issues/)
and [Discussions](https://github.com/CelticBoozer/dotfiles/discussions/).

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as
Expand Down Expand Up @@ -202,8 +202,8 @@ For the full guide, see [here](https://www.conventionalcommits.org/en/v1.0.0/).
### Code style

All code must be linted and formatted according to the rules. A list of linters,
formatters and their configurations can be found in the [repository](https://github.com/CelticBoozer/lint-format-config).
formatters and their configurations can be found in the [repository](https://github.com/CelticBoozer/lint-format-config/).

## Attribution

This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen/)!
Loading

0 comments on commit df31337

Please sign in to comment.