[doc] Create the readme file

This commit is contained in:
Anas Elgarhy 2023-05-12 00:32:08 +03:00
parent 72823efc04
commit c205da71ea
No known key found for this signature in database
GPG key ID: 0501802A1D496528
2 changed files with 30 additions and 0 deletions

30
README.md Normal file
View file

@ -0,0 +1,30 @@
# archy-slstatus
## The status bar for archy-slstatus
![simple screenshot](./screenshots/1.0.0.png)
### Installation
You can install archy-slstatus from the AUR with your favorite AUR helper.
```sh
yay -S archy-slstatus
```
Or you can install the latest version from the git repository.
```sh
yay -S archy-slstatus-git
```
Or you can build it yourself.
```sh
git clone https://github.com/archy-linux/archy-slstatus.git
cd archy-slstatus
sudo make install clean
```
### Mirrors
* [GitHub](https://github.com/archy-linux/archy-slstatus) - The upstream repository
* [GitLab](https://gitlab.com/archy-linux/archy-slstatus) - [![Mirror the repo to gitlab](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitlab-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitlab-mirror.yml)
* [NotABug](https://notabug.org/archy-linux/archy-slstatus) - Not instant updates
* [Codeberg](https://codeberg.org/archy-linux/archy-slstatus) - [![Mirror the repo to codeberg](https://github.com/archy-linux/archy-slstatus/actions/workflows/codeberg-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/codeberg-mirror.yml)
* [Gitea](https://gitea.com/archy-linux/archy-slstatus) - [![Mirror the repo to Gitea](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitea-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitea-mirror.yml)
* [Gitdab](https://gitdab.com/archy-linux/archy-slstatus) - [![Mirror the repo to Gitdab](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitdab-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitdab-mirror.yml)
* [Pagure](https://pagure.io/archy-slstatus) - [![Mirror the repo to pagure](https://github.com/archy-linux/archy-slstatus/actions/workflows/pagure-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/pagure-mirror.yml)
* [Bitbucket](https://bitbucket.org/archy-linux/archy-slstatus) - [![Mirror the repo to bitbucket](https://github.com/archy-linux/archy-slstatus/actions/workflows/bitbucket-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/bitbucket-mirror.yml)
* [disroot](https://git.disroot.org/archy-linux/archy-slstatus) - [![Mirror the repo to disroot](https://github.com/archy-linux/archy-slstatus/actions/workflows/disroot-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/disroot-mirror.yml)

BIN
screenshots/1.0.0.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB