Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@1995parham
1995parham committed Sep 6, 2023
1 parent b72f1e0 commit 3665811
Showing 1 changed file with 71 additions and 71 deletions.
142 changes: 71 additions & 71 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<h1 align="center">1995parham's dotfiles</h1>

<p align="center">
<img alt="GitHub" src="https://img.shields.io/github/license/1995parham/dotfiles?logo=gnu&style=for-the-badge">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/1995parham/dotfiles/install.yaml?logo=github&style=for-the-badge&label=install">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/1995parham/dotfiles/sh-lint.yaml?label=lint&logo=github&style=for-the-badge">
<a href="https://github.com/1995parham-me/ansible-role">
<img alt="Ansible" src="https://img.shields.io/badge/ansible-ready-black?logo=ansible&style=for-the-badge">
</a>
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/1995parham/dotfiles?style=for-the-badge">
<img alt="GitHub" src="https://img.shields.io/github/license/1995parham/dotfiles?logo=gnu&style=for-the-badge">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/1995parham/dotfiles/install.yaml?logo=github&style=for-the-badge&label=install">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/1995parham/dotfiles/sh-lint.yaml?label=lint&logo=github&style=for-the-badge">
<a href="https://github.com/1995parham-me/ansible-role">
<img alt="Ansible" src="https://img.shields.io/badge/ansible-ready-black?logo=ansible&style=for-the-badge">
</a>
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/1995parham/dotfiles?style=for-the-badge">
</p>

## Introduction
Expand All @@ -21,9 +21,9 @@ Special thanks to [@elahe-dastan](https://github.com/elahe-dastan/) for using th
## Installation

<p align="center">
<img alt="Compatibility" src="https://img.shields.io/badge/works%20on-macos-white?logo=macos&style=for-the-badge">
<img alt="Compatibility" src="https://img.shields.io/badge/works%20on-ubuntu-orange?logo=ubuntu&style=for-the-badge">
<img alt="Compatibility" src="https://img.shields.io/badge/works%20on-arch-blue?logo=archlinux&style=for-the-badge">
<img alt="Compatibility" src="https://img.shields.io/badge/works%20on-macos-white?logo=macos&style=for-the-badge">
<img alt="Compatibility" src="https://img.shields.io/badge/works%20on-ubuntu-orange?logo=ubuntu&style=for-the-badge">
<img alt="Compatibility" src="https://img.shields.io/badge/works%20on-arch-blue?logo=archlinux&style=for-the-badge">
</p>

You need to first install an operating system to use these `dotfiles`,
Expand Down Expand Up @@ -114,67 +114,67 @@ If an application is marked with a (?), it means I had a negative experience wit

To find software compatible with sway, always check the [`are we wayland yet`](https://arewewaylandyet.com/) website.

| Role | How to Install? | ArchLinux | OSx |
| :--------------------: | :------------------------------ | :---------------------------------------- | :------------- |
| Anydesk | `anydesk-bin (yay)` | Anydesk | - |
| Browser | `./start.sh browser` | Firefox, Firefox Developer Edition, etc. | Firefox, etc. |
| Calendar | `./start.sh env` | `cal`, `jcal` | - |
| Camera | `guvcview (pacman)` | `guvcview` | Photo Booth |
| cat clone with wings | `./start.sh env` | `bat` | `bat` |
| Fetch | `./start.sh fetch` | `neofetch`, `onefetch`, `tokei` | ` |
| BTop | `./start.sh btop` | `btop` | ` |
| Container Engine | `./start.sh docker` | `docker` | Docker Desktop |
| Container Engine | `./start.sh podman` | `podman` | `podman` |
| Desktop Manager | `./archinstall/sway.sh` | `greetd`, `greetd-tuigreet` | - |
| Window Manager | `./archinstall/sway.sh` | `sway` | - |
| Dictionary | `./start.sh def` | `def` | `def` |
| Download Manager | `./start.sh env` | `aria2c` | `aria2c` |
| Drawing Diagram | `./start.sh drawio` | `drawio` | `drawio` |
| Emacs | `./start.sh emacs` | `emacs` | `emacs` (?) |
| GNU Privacy Guard | `./start.sh env` | `gpg` | - |
| Habit Tracker | `./start.sh dijo` | `dijo` | - |
| HTTP/GRPC Load Test | `./start.sh env` | `k6` | `k6` |
| Image Editor | `./start.sh image` | GNU Image Manipulation Program, `convert` | Preview |
| Image Viewer | `./start.sh sway` | `imv` | Preview |
| Terminal Image Viewer | `./start.sh env` | `chafa` | - |
| Launcher | `./start.sh sway` | `rofi` | - |
| MP3 Tags | `./start.sh mpd` | Strawberry | iTunes |
| Music Player | `./start.sh mpd` | `mpc`, `ncmpcpp` | - |
| neovim | `./start.sh neovim` | `nvim` | `nvim` |
| vim | `./start.sh env` | `vim` | `vim` |
| Networking | `NetworkManager (archinstall)` | `nmtui`, `nmcli` | - |
| Network Time Protocol | `chrony (pacman)` | - | - |
| Note Keeping | `xournalpp (pacman)` | Xournalpp | Xournalpp |
| Office Suite | `./start.sh office` | LibreOffice | Office |
| Packet Sniffer | `./start.sh wireshark` | Wireshark | - |
| Packet Sniffer | `termshark (pacman)` | `termshark` | - |
| Password Manager | `./start.sh gopass` | `gopass` | `gopass` |
| PDF Viewer | `./start.sh sway` | `mupdf` | Preview |
| Power Manager | - | - | - |
| Skype | skypeforlinux-preview-bin (yay) | Skype Preview | Skype |
| Clipboard | ./start.sh sway | `wl-copy`, `wl-paste` | - |
| Wayland Evnets | wev (yay) | `wev` | - |
| Network Speed | ./start.sh env | `speedtest-cli` | - |
| Status Bar | ./start.sh sway | `waybar` | - |
| Syncthing | ./start.sh syncthing | `syncthing` | `syncthing` |
| Terminal Emulator | ./start.sh alacritty | `alacritty` | Alacritty (?) |
| Terminal Emulator | ./start.sh kitty | `kitty` | Kitty |
| Terminal Emulator | ./start.sh foot | `foot` | - |
| Terminal Multiplexer | ./start.sh env | `tmux` | `tmux` |
| Video Editor | `ffmpeg (pacman)` | `ffmpeg` | `ffmpeg` |
| Video Player | `./start.sh mpv` | `mpv` | `mpv` |
| Wallpaper | `./start.sh sway` | `wpaperd` | - |
| Youtube Downloader | `./start.sh yt-dlp` | `yt-dlp` | `yt-dlp` |
| Timezone | `./start.sh gotz` | `gotz` | - |
| Google Cloud | `./start.sh gcloud` | `gcloud` | - |
| Multi-OS Bootable Disk | `./start.sh ventoy` | `ventoy` | - |
| LaTex/XeTex/Texlive | `./start.sh texlive` | `tlmgr`, `xelatex`, `latexmk`, etc. | - |
| Android, Quest | `./start.sh android` | `adb`, SideQuest | - |
| Bandwidth Usage | `./start.sh env` | `bandwhich` | - |
| TLDR | `./start.sh tealdeer` | `tldr` | - |
| DNS | `./start.sh blocky` | `blocky` | - |
| JSON | `./start.sh env` | `jq`, `jless` | - |
| Disk Usage Analyzer | `./start.sh env` | `dua` | `dua` |
| Role | How to Install? | ArchLinux | OSx |
| :--------------------: | :-------------------------------- | :---------------------------------------- | :------------- |
| Anydesk | `anydesk-bin (yay)` | Anydesk | - |
| Browser | `./start.sh browser` | Firefox, Firefox Developer Edition, etc. | Firefox, etc. |
| Calendar | `./start.sh env` | `cal`, `jcal` | - |
| Camera | `guvcview (pacman)` | `guvcview` | Photo Booth |
| cat clone with wings | `./start.sh env` | `bat` | `bat` |
| Fetch | `./start.sh fetch` | `neofetch`, `onefetch`, `tokei` | ` |
| BTop | `./start.sh btop` | `btop` | ` |
| Container Engine | `./start.sh docker` | `docker` | Docker Desktop |
| Container Engine | `./start.sh podman` | `podman` | `podman` |
| Desktop Manager | `./archinstall/sway.sh` | `greetd`, `greetd-tuigreet` | - |
| Window Manager | `./archinstall/sway.sh` | `sway` | - |
| Dictionary | `./start.sh def` | `def` | `def` |
| Download Manager | `./start.sh env` | `aria2c` | `aria2c` |
| Drawing Diagram | `./start.sh drawio` | `drawio` | `drawio` |
| Emacs | `./start.sh emacs` | `emacs` | `emacs` (?) |
| GNU Privacy Guard | `./start.sh env` | `gpg` | - |
| Habit Tracker | `./start.sh dijo` | `dijo` | - |
| HTTP/GRPC Load Test | `./start.sh env` | `k6` | `k6` |
| Image Editor | `./start.sh image` | GNU Image Manipulation Program, `convert` | Preview |
| Image Viewer | `./start.sh sway` | `imv` | Preview |
| Terminal Image Viewer | `./start.sh env` | `chafa` | - |
| Launcher | `./start.sh sway` | `rofi` | - |
| MP3 Tags | `./start.sh mpd` | Strawberry | iTunes |
| Music Player | `./start.sh mpd` | `mpc`, `ncmpcpp` | - |
| neovim | `./start.sh neovim` | `nvim` | `nvim` |
| vim | `./start.sh env` | `vim` | `vim` |
| Networking | `NetworkManager (archinstall)` | `nmtui`, `nmcli` | - |
| Network Time Protocol | `chrony (pacman)` | - | - |
| Note Keeping | `xournalpp (pacman)` | Xournalpp | Xournalpp |
| Office Suite | `./start.sh office` | LibreOffice | Office |
| Packet Sniffer | `./start.sh wireshark` | Wireshark | - |
| Packet Sniffer | `termshark (pacman)` | `termshark` | - |
| Password Manager | `./start.sh gopass` | `gopass` | `gopass` |
| PDF Viewer | `./start.sh sway` | `mupdf` | Preview |
| Power Manager | - | - | - |
| Skype | `skypeforlinux-preview-bin (yay)` | Skype Preview | Skype |
| Clipboard | `./start.sh sway` | `wl-copy`, `wl-paste` | - |
| Wayland Evnets | `wev (yay)` | `wev` | - |
| Network Speed | `./start.sh env` | `speedtest-cli` | - |
| Status Bar | `./start.sh sway` | `waybar` | - |
| Syncthing | `./start.sh syncthing` | `syncthing` | `syncthing` |
| Terminal Emulator | `./start.sh alacritty` | `alacritty` | Alacritty (?) |
| Terminal Emulator | `./start.sh kitty` | `kitty` | Kitty |
| Terminal Emulator | `./start.sh foot` | `foot` | - |
| Terminal Multiplexer | `./start.sh env` | `tmux` | `tmux` |
| Video Editor | `ffmpeg (pacman)` | `ffmpeg` | `ffmpeg` |
| Video Player | `./start.sh mpv` | `mpv` | `mpv` |
| Wallpaper | `./start.sh sway` | `wpaperd` | - |
| Youtube Downloader | `./start.sh yt-dlp` | `yt-dlp` | `yt-dlp` |
| Timezone | `./start.sh gotz` | `gotz` | - |
| Google Cloud | `./start.sh gcloud` | `gcloud` | - |
| Multi-OS Bootable Disk | `./start.sh ventoy` | `ventoy` | - |
| LaTex/XeTex/Texlive | `./start.sh texlive` | `tlmgr`, `xelatex`, `latexmk`, etc. | - |
| Android, Quest | `./start.sh android` | `adb`, SideQuest | - |
| Bandwidth Usage | `./start.sh env` | `bandwhich` | - |
| TLDR | `./start.sh tealdeer` | `tldr` | - |
| DNS | `./start.sh blocky` | `blocky` | - |
| JSON | `./start.sh env` | `jq`, `jless` | - |
| Disk Usage Analyzer | `./start.sh env` | `dua` | `dua` |

## [Window Managers](https://wiki.archlinux.org/title/Window_manager) (on ArchLinux)

Expand Down

0 comments on commit 3665811

Please sign in to comment.