Skip to content

Commit 70b1c6e

Browse files
add github actions to generate deb package
1 parent 9edc25f commit 70b1c6e

3 files changed

Lines changed: 72 additions & 7 deletions

File tree

.github/workflows/build-deb.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Build Debian Package
2+
3+
'on':
4+
push:
5+
branches:
6+
- kde-fix
7+
pull_request:
8+
release:
9+
types:
10+
- published
11+
workflow_dispatch:
12+
13+
jobs:
14+
build-deb:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Check out repository
19+
uses: actions/checkout@v6
20+
21+
- name: Install packaging dependencies
22+
run: |
23+
sudo apt-get update
24+
sudo apt-get install -y \
25+
dpkg-dev \
26+
devscripts \
27+
equivs \
28+
fakeroot \
29+
build-essential
30+
# Install Build-Depends from debian/control to keep CI aligned with packaging metadata.
31+
sudo mk-build-deps --install --remove --tool 'apt-get -y --no-install-recommends' debian/control
32+
33+
- name: Build Debian package
34+
run: dpkg-buildpackage -us -uc -b
35+
36+
- name: Collect Debian artifacts
37+
run: |
38+
mkdir -p artifacts
39+
cp -v ../*.deb ../*.buildinfo ../*.changes artifacts/
40+
41+
- name: Upload Debian artifacts
42+
uses: actions/upload-artifact@v7
43+
with:
44+
name: vboard-deb-${{ github.sha }}
45+
path: |
46+
artifacts/*.deb
47+
artifacts/*.buildinfo
48+
artifacts/*.changes
49+
if-no-files-found: error

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,22 @@ The keyboard supports customizable colors, opacity settings, and can be easily m
2727

2828
## Installation
2929

30+
### Ubuntu/Debian: `.deb` package
31+
32+
Download the latest `.deb` from the GitHub Releases page, then install it with:
33+
34+
```bash
35+
sudo apt install ./vboard_*.deb
36+
```
37+
38+
The package post-install step sets up `uinput` and installs the `udev` rule needed for desktop-session access to `/dev/uinput`.
39+
40+
Log out and back in, or reboot, after installation.
3041

3142
### PPA for Ubuntu
3243

33-
Run the following commands to install vboard from its official PPA:
44+
You can also use the following PPA in Ubuntu.
45+
Run the following commands one by one:
3446

3547
```bash
3648
sudo add-apt-repository ppa:apandada1/vboard
@@ -40,9 +52,9 @@ sudo apt install vboard
4052

4153
**Restart for changes to take effect**.
4254

43-
### Install from source in Ubuntu/Debian
55+
### Ubuntu/Debian: install from source
4456

45-
For Ubuntu and Debian-based systems, use the automated setup script for a complete installation:
57+
For the latest unreleased changes on Ubuntu and Debian-based systems, use the automated setup script:
4658

4759
```bash
4860
git clone https://github.com/archisman-panigrahi/vboard.git
@@ -52,9 +64,9 @@ sudo bash setup-ubuntu-debian.sh
5264

5365
This script will handle all setup steps including dependency installation, uinput configuration, and system-wide installation. A system restart is recommended after installation.
5466

55-
### Manual Installation
67+
### Manual installation on other distros
5668

57-
For other distributions or custom setups, follow the steps below.
69+
For Debian/Ubuntu, Fedora, Arch, and other distributions, install the dependencies manually and then build with Meson.
5870

5971
### 1. Install dependencies
6072

@@ -71,6 +83,10 @@ sudo apt install hunspell-en-us
7183
```bash
7284
sudo dnf install python3-gobject gtk3 python3-uinput libappindicator-gtk3 meson ninja-build
7385
```
86+
Optional for word suggestions:
87+
```bash
88+
sudo dnf install hunspell-en-US
89+
```
7490

7591
**For Arch-based distributions:**
7692
```bash
@@ -81,7 +97,7 @@ Optional for word suggestions:
8197
sudo pacman -S hunspell-en_us
8298
```
8399

84-
### 2. Download latest master
100+
### 2. Clone the repository
85101

86102
```bash
87103
git clone https://github.com/archisman-panigrahi/vboard.git

debian/source/format

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.0 (native)
1+
3.0 (quilt)

0 commit comments

Comments
 (0)