docs: add project README files

Add English and Russian README documentation for the Kyocera GDI driver package.
2026-09-23 23:29:59 +04:00
parent 6815082bfa
commit 1be2b5c771
2 changed files with 203 additions and 0 deletions
@@ -0,0 +1,104 @@
+# kyocera-fs-1x2x-mfp-gdi
+
+Kyocera GDI printer driver package for Arch Linux and CUPS.
+
+This project packages the Linux GDI driver files for a group of legacy Kyocera FS-1xxx printers and installs them in the standard CUPS locations. The package is distributed as an Arch Linux `PKGBUILD`.
+
+## Supported printers
+
+The package currently installs PPD files for:
+
+- Kyocera FS-1020MFP
+- Kyocera FS-1025MFP
+- Kyocera FS-1040
+- Kyocera FS-1060DN
+- Kyocera FS-1120MFP
+- Kyocera FS-1125MFP
+
+All of these models use the bundled `rastertokpsl` CUPS filter.
+
+## Requirements
+
+- Arch Linux or another Arch-compatible environment with `makepkg`
+- `cups`
+- `x86_64`
+
+The package declares `cups` as a runtime dependency and is built for `x86_64`.
+
+## Build and install
+
+Clone the repository, then build the package with `makepkg`:
+
+```bash
+git clone <repository-url>
+cd kyocera-fs-1x2x-mfp-gdi
+makepkg -si
+```
+
+After installation, restart CUPS if necessary:
+
+```bash
+sudo systemctl restart cups
+```
+
+The installed PPD files are placed under:
+
+```text
+/usr/share/cups/model/Kyocera/
+```
+
+The CUPS filter is installed as:
+
+```text
+/usr/lib/cups/filter/rastertokpsl
+```
+
+## Printer setup
+
+Add the printer through your desktop's printer settings or through the CUPS web interface at `http://localhost:631/`.
+
+When selecting a driver manually, use the PPD matching the exact printer model, for example:
+
+```text
+/usr/share/cups/model/Kyocera/Kyocera_FS-1040GDI.ppd
+```
+
+## Package details
+
+Current package version:
+
+```text
+1.1203-1
+```
+
+The PKGBUILD fetches the driver archive from Kyocera Document Solutions and extracts the Russian 64-bit driver payload before installing the required PPD files and `rastertokpsl` filter.
+
+Upstream archive:
+
+```text
+https://www.kyoceradocumentsolutions.ru/content/dam/download-center-cf/ru/drivers/all/LinuxDrv_1_1203_FS_1x2xMFP_zip.download.zip
+```
+
+## Files installed
+
+```text
+/usr/share/cups/model/Kyocera/
+├── Kyocera_FS-1020MFPGDI.ppd
+├── Kyocera_FS-1025MFPGDI.ppd
+├── Kyocera_FS-1040GDI.ppd
+├── Kyocera_FS-1060DNGDI.ppd
+├── Kyocera_FS-1120MFPGDI.ppd
+└── Kyocera_FS-1125MFPGDI.ppd
+
+/usr/lib/cups/filter/rastertokpsl
+```
+
+## Licensing
+
+The repository's packaging metadata is dedicated to the public under **CC0-1.0**. See [`LICENSES/CC0-1.0.txt`](LICENSES/CC0-1.0.txt) and [`PKGBUILD.license`](PKGBUILD.license).
+
+This does not change the copyright or licensing terms of the Kyocera driver files obtained from the upstream archive. The upstream driver components remain subject to their respective terms.
+
+## Source and attribution
+
+The packaged driver originates from Kyocera Document Solutions. This repository provides the Arch Linux packaging needed to install the legacy Linux GDI driver through CUPS.