vndangkhoa/vietc
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions 1

docs: add distro support table, fix deps and config typo
Some checks are pending
Build & Release / Build & test (push) Waiting to run
Details
Build & Release / Build .deb (push) Blocked by required conditions
Details

Browse source
This commit is contained in:
Khoa Vo 2026-07-01 17:05:41 +07:00
parent a09ba8ed63
commit 473773abf2
2 changed files with 29 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -111,11 +111,27 @@ Both **VNI** and **Telex** are fully supported. Switch via **Ctrl+LeftShift** or
--- ---
## Distro Support
| Tier | Distro | Install Method | Status |
|------|--------|---------------|--------|
| ✅ **Supported** | Ubuntu, Debian, Linux Mint, Pop!_OS, elementary OS, Zorin, Neon | `apt` (auto-detected) | Tested, one-command install |
| ✅ **Supported** | Fedora, RHEL, CentOS | `dnf` (auto-detected) | Tested, one-command install |
| ✅ **Supported** | Arch, Manjaro | `pacman` (auto-detected) | Tested, one-command install |
| ⚠️ **Might support** | openSUSE, Solus, Void | `zypper`/`eopkg`/`xbps` (manual) | Package names may differ; run install.sh and install missing deps manually if it fails |
| ❌ **Not supported** | NixOS, Alpine, Gentoo, others | N/A | No package manager entry — install deps manually, then `cargo build --release` |
> **⚠️ Tray icon note:** GNOME (Ubuntu) and Cinnamon (Mint) need a StatusNotifier watcher for the tray to appear:
> - Ubuntu: `sudo apt install gnome-shell-extension-appindicator`
> - Mint: pre-installed; works out of the box
---
## Installation ## Installation
### One-Command Install ### One-Command Install
Works on both **Linux Mint** and **Ubuntu** (including 24.04+ Wayland): Works on all ✅ **Supported** distros above. The script auto-detects your package manager:
**From GitHub (recommended):** **From GitHub (recommended):**
```bash ```bash
@ -150,7 +166,7 @@ curl -sSL https://git.khoavo.myds.me/vndangkhoa/vietc/raw/branch/main/uninstall.
```bash ```bash
# Install dependencies # Install dependencies
sudo apt install git curl build-essential pkg-config \ sudo apt install git curl build-essential pkg-config \
libx11-dev libxtst-dev libevdev-dev libdbus-1-dev wl-clipboard libx11-dev libxtst-dev libevdev-dev libdbus-1-dev libwayland-dev wl-clipboard
# Enable accessibility (Ubuntu Wayland — for password detection) # Enable accessibility (Ubuntu Wayland — for password detection)
gsettings set org.gnome.desktop.a11y.applications screen-reader-enabled true gsettings set org.gnome.desktop.a11y.applications screen-reader-enabled true

18
install.sh
View file

@ -21,16 +21,20 @@ install_deps() {
export DEBIAN_FRONTEND=noninteractive export DEBIAN_FRONTEND=noninteractive
apt-get update -y apt-get update -y
apt-get install -y build-essential pkg-config libx11-dev libxtst-dev \ apt-get install -y build-essential pkg-config libx11-dev libxtst-dev \
libdbus-1-dev libevdev-dev curl git libdbus-1-dev libevdev-dev libwayland-dev curl git
apt-get install -y libevdev2 libdbus-1-3 libx11-6 libxtst6 xclip wl-clipboard apt-get install -y libevdev2 libdbus-1-3 libx11-6 libxtst6 \
libwayland-client0 xclip wl-clipboard
;; ;;
fedora|rhel|centos) fedora|rhel|centos)
dnf install -y gcc pkgconfig libX11-devel libXtst-devel dbus-devel libevdev-devel curl git dnf install -y gcc pkgconfig libX11-devel libXtst-devel dbus-devel \
dnf install -y libevdev libX11 libXtst dbus-libs xclip wl-clipboard libevdev-devel libwayland-devel curl git
dnf install -y libevdev libX11 libXtst dbus-libs libwayland-client xclip wl-clipboard
;; ;;
arch|manjaro) arch|manjaro)
pacman -Sy --needed --noconfirm base-devel pkgconf libx11 libxtst dbus libevdev curl git pacman -Sy --needed --noconfirm base-devel pkgconf libx11 libxtst dbus \
pacman -Sy --needed --noconfirm libevdev libx11 libxtst dbus xclip wl-clipboard libevdev wayland curl git
pacman -Sy --needed --noconfirm libevdev libx11 libxtst dbus \
libwayland xclip wl-clipboard
;; ;;
*) *)
echo -e "${YELLOW}Unsupported: $DISTRO. Install deps manually.${NC}" echo -e "${YELLOW}Unsupported: $DISTRO. Install deps manually.${NC}"
@ -98,7 +102,7 @@ grab = true
enabled = true enabled = true
check_atspi2 = true check_atspi2 = true
check_window_title = true check_window_title = true
title_keywords = ["password", "passphrase", "secret", "mặt khẩu", "sudo"] title_keywords = ["password", "passphrase", "secret", "mật khẩu", "sudo"]
password_apps = ["pinentry", "pinentry-gtk-2", "pinentry-qt", "kwallet"] password_apps = ["pinentry", "pinentry-gtk-2", "pinentry-qt", "kwallet"]
[app_state] [app_state]