70 lines
2.1 KiB
Markdown
70 lines
2.1 KiB
Markdown
# Hatsune Miku's Shoshitsu in Terminal
|
|
|
|
A C++ program that runs in the terminal, packaged for Debian-based Linux
|
|
distributions (Debian, Ubuntu, Linux Mint, Pop!_OS, ...).
|
|
|
|
## Project layout
|
|
|
|
```
|
|
main.cpp the program (placeholder — replace with your code)
|
|
CMakeLists.txt CMake build (used by both Windows and Linux builds)
|
|
debian/ Debian source-package structure
|
|
control package metadata (name, version, deps, description)
|
|
changelog version history for the package
|
|
copyright license/copyright info
|
|
rules debhelper build rules (runs CMake, installs files)
|
|
compat debhelper compatibility level (13)
|
|
source/format 3.0 (quilt)
|
|
install which built files go into the package
|
|
build-deb.sh full .deb build via debhelper (recommended)
|
|
pack-deb.sh minimal .deb build via dpkg-deb (no debhelper)
|
|
```
|
|
|
|
## Building the .deb
|
|
|
|
The package must be built **on Debian-family Linux** (or in WSL2 / a Docker
|
|
container). Build it with debhelper (recommended):
|
|
|
|
```sh
|
|
sudo apt install build-essential cmake debhelper
|
|
./build-deb.sh
|
|
```
|
|
|
|
or, if you don't want debhelper, with the minimal script:
|
|
|
|
```sh
|
|
sudo apt install build-essential cmake
|
|
./pack-deb.sh
|
|
```
|
|
|
|
Both drop a `.deb` file into `./dist/`.
|
|
|
|
## Installing the package
|
|
|
|
```sh
|
|
sudo apt install ./dist/hatsune-miku-shoshitsu_*.deb
|
|
# or
|
|
sudo dpkg -i ./dist/hatsune-miku-shoshitsu_*.deb
|
|
```
|
|
|
|
The binary is installed to `/usr/bin/hatsune-miku-shoshitsu`, so run it with:
|
|
|
|
```sh
|
|
hatsune-miku-shoshitsu
|
|
```
|
|
|
|
To uninstall:
|
|
|
|
```sh
|
|
sudo apt remove hatsune-miku-shoshitsu
|
|
```
|
|
|
|
## Customizing before release
|
|
|
|
- `debian/control` — set a real `Maintainer` and a real `Description`.
|
|
- `debian/changelog` — bump the version and add your own entry.
|
|
- `debian/copyright` — pick the license this project is actually under.
|
|
- `main.cpp` — replace the placeholder with the real program.
|
|
- `CMakeLists.txt` — if you add more `.cpp` files, list them in
|
|
`add_executable(...)`.
|