diff --git a/README.de_DE.md b/README.de_DE.md index aec3dce..0b5aa29 100644 --- a/README.de_DE.md +++ b/README.de_DE.md @@ -1,14 +1,17 @@ # Cat-Printer -Ein Projekt, das Unterstützung für einige Bluetooth-"Cat Printer"-Modelle auf *vielen* Plattformen bietet! +🐱🖨 Ein Projekt, das Unterstützung für einige Bluetooth-"Cat Printer"-Modelle auf *vielen* Plattformen bietet! ## unterstützte Geräte Gegenwärtig: -- GB01 -- GB02 -- GT01 + +| | | +|-------------|-------------------| +| Supported | GB01, GB02, GT01 | +| Maybe | GB03 | +| Planned | N/A | ## Funktionen @@ -17,7 +20,6 @@ Gegenwärtig: - oder besorgen Sie sich die Android-Version! - ~~Umfangreiche Funktionen~~ - Derzeit befindet sich die Software im Alpha-Stadium. Mehr wird es bald geben! - - Sie können immer noch die Vorgängerversion (0.0.2) verwenden, die einige weitere Bearbeitungsfunktionen bietet - Friendly! - Sprachunterstützung! Sie können sich an der Übersetzung beteiligen! - Gute Benutzeroberfläche, mit PC-/Mobil-/Licht-/Dunkelmodus-Varianten! (Systemkonfiguration adaptiv) @@ -40,13 +42,13 @@ Holen Sie sich die neueste apk-Version und installieren Sie sie. Es kann sein, dass es um die Erlaubnis bittet, den Standort im Hintergrund zu finden, was mir ein Rätsel ist. Sie können es sicher verweigern. -### Windows: +### Windows Holen Sie sich die neueste Version des Archivs mit "windows" im Dateinamen, entpacken Sie es an einen beliebigen Ort und führen Sie "start.bat" aus. ### GNU/Linux -Sie können sich die "reine" Version besorgen, sie extrahieren, ein Terminal starten und dies ausführen: +Sie können sich die "reine(pure)" Version besorgen, sie extrahieren, ein Terminal starten und dies ausführen: ```bash python3 server.py ``` @@ -60,7 +62,7 @@ sudo pacman -S bluez bluez-utils Für MacOS installieren Sie bitte [Python 3](https://www.python.org/). -Holen Sie eine "reine" Version und tun Sie dasselbe in einer Shell wie bei Linux: +Holen Sie eine "reine(pure)" Version und tun Sie dasselbe in einer Shell wie bei Linux: ```bash python3 server.py ``` diff --git a/README.md b/README.md index 964c20f..ddbc9f6 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ -English | [Deutsch](./README.de_DE.md) +English | [Deutsch](./README.de_DE.md) | [简体中文](./README.zh_CN.md) # Cat-Printer -A project that provides support to some Bluetooth "Cat Printer" models, on *many* platforms! +🐱🖨 A project that provides support to some Bluetooth "Cat Printer" models, on *many* platforms! ## Models -Currently: - GB01, GB02, and GT01 - maybe GB03 in the current repo state +Currently: + +| | | +|-------------|-------------------| +| Supported | GB01, GB02, GT01 | +| Maybe | GB03 | +| Planned | N/A | ## Features @@ -16,18 +20,17 @@ Currently: - Operate via a Web UI just in browser, - or get the Android release! - ~~Feature-rich~~ - - Currently it is in Alpha stage. More will be there soon! - - You can still use the legacy version (0.0.2), with some more editing features + - Currently it's in development. More will be there soon! - Friendly! - Language support! You can participate in translation! - - Good user interface, with PC/mobile/light/dark mode variants! (system config adaptive) + - Good user interface, adaptive to PC/mobile and light/dark theme! - Cross platform! - Newer Windows 10 and above - GNU/Linux - MacOS *(Needs testing)* - and a lot of extra efforts for Android! - Free, as in [freedom](https://www.gnu.org/philosophy/free-sw.html)! - - Unlike the "official" proprietary app, + - Unlike the "original" proprietary app, this project is for everyone that concerns *open-mind and freedom*! - and Fun! - Do whatever you like! @@ -38,10 +41,10 @@ Currently: Get the newest apk release and install, then well done! -It may ask for background location permission, which is mysterious to me. -You can deny it safely. +It may ask for background location permission, you can deny it safely. +(Foreground) Location permission is required for scanning Bluetooth devices in newer Android system. -### Windows: +### Windows Get the newest release archive with "windows" in the file name, extract to somewhere and run `start.bat` @@ -67,15 +70,17 @@ Fetch a "pure" release and do the same in a shell: python3 server.py ``` -Currently in Mac the browser will not pop up automatically. Please run manually and go to `http://127.0.0.1:8095` +Currently in Mac the browser will not pop up automatically. Please run manually and go to `http://127.0.0.1:8095`, or just click [here](http://127.0.0.1:8095). -### Note +### Worth to Note For all supported platforms, You can also use "pure" edition once you have [Python 3](https://www.python.org/) installed, or "bare" edition if you also managed to install `bleak` via `pip`. +Command line hackers? Just use `printer.py`! + See the [releases](https://github.com/NaitLee/Cat-Printer/releases) now! ## Problems? @@ -95,6 +100,7 @@ See file `COPYING`, `LICENSE`, and detail of used JavaScript in file `www/jslice ## Development You may interested in language support, anyway. See the translation files in directory `www/lang`! +Note: you can correct some mistakes in them, if there are any. Also feel free to make it (truly) better! Also interested in code development? See [development.md](development.md)! diff --git a/README.zh_CN.md b/README.zh_CN.md new file mode 100644 index 0000000..397ae2d --- /dev/null +++ b/README.zh_CN.md @@ -0,0 +1,115 @@ + +# Cat-Printer + +🐱🖨 猫咪打印机：此应用*跨平台地*对一些蓝牙“喵喵机”提供支持！ + +## 型号 + +目前有： + +| | | +|-----------|-------------------| +| 支持 | GB01, GB02, GT01 | +| 可能支持 | GB03 | +| 计划 | 暂无 | + +## 特性 + +- 简易！ + - 在网页界面进行操作， + - 或者获取安卓应用！ +- ~~功能丰富~~ + - 当前仍在继续开发。以后会有更多！ +- 友好！ + - 语言支持！您可参与翻译！ + - 良好的用户界面，可适应桌面/移动端/明暗主题！ +- 跨平台！ + - 较新的 Windows 10 及以上 + - GNU/Linux + - MacOS *（需要测试）* + - 在安卓上也花了些功夫呢！ +- 是[自由软件](https://www.gnu.org/philosophy/free-sw.html)！ + - 不像“原版”专有应用，此作品为在乎*开放思想与计算自由*的人而生！ +- 有意思！ + - 做什么都可以！ + +## 现在开始 + +### 安卓 + +获取并安装最新版安卓 apk 包，完成！ + +应用可能请求“后台位置”权限，您可以拒绝它。 +（前台）位置权限是较新版安卓系统扫描蓝牙设备所需要的。 + +### Windows + +获取名称中有 "windows" 的版本， +解压并运行 `start.bat` + +### GNU/Linux + +您可以获取“纯净(pure)”版，解压、在其中打开终端并输入： +```bash +python3 server.py +``` + +在 Arch Linux 等发行版您可能需要首先安装 `bluez` +```bash +sudo pacman -S bluez bluez-utils +``` + +### MacOS + +MacOS 用户请首先安装 [Python 3](https://www.python.org/)。 + +然后获取“纯净(pure)”版，并做同样的事情： +```bash +python3 server.py +``` + +当前在 MacOS 浏览器不会自动打开。您可以手动访问 `http://127.0.0.1:8095`，或点击[这里](http://127.0.0.1:8095) + + +### 值得注意 + +对于所有支持的平台， +当已安装 [Python 3](https://www.python.org/) 时，您可以直接获取“纯净(pure)”版， +或在已使用 `pip` 安装 `bleak` 时使用“单一(bare)”版。 + +命令行高手？直接用 `printer.py`！ + +查看所有[发布版本](https://github.com/NaitLee/Cat-Printer/releases)！ + +## 有问题？ + +有想法？开个 issue！ + +如果能行，PR 也可以！ + +## 许可证 + +Copyright © 2022 NaitLee Soft. 保留一些权利。 + +敬请查看文件 `COPYING`，`LICENSE`，以及在 `www/jslicense.html` 中有关 JavaScript 许可的详细内容。 + +-------- + +## 开发 + +您可能对翻译工作感兴趣。可于目录 `www/lang` 中查看翻译文件！ +注： +1. 通常英语与简体中文同时更新。请考虑其他，如繁体中文（需注意在繁体中与简体的用字、技术术语差别）。 +2. 如果您有（真的）能力，您也可以纠正/改善某些翻译！ + +还想写代码？看看 [development.md](development.md)！（英文） + +### 鸣谢 + +- 当然不能没有 Python 和 Web 技术！ +- [Bleak](https://bleak.readthedocs.io/en/latest/) 蓝牙低功耗库，牛！ +- [roddeh-i18n](https://github.com/roddeh/i18njs)，好活！ +- [python-for-android](https://python-for-android.readthedocs.io/en/latest/)，虽然有些麻烦的地方 +- [AdvancedWebView](https://github.com/delight-im/Android-AdvancedWebView) 从 Java 拯救了我的生命 +- Stack Overflow 和互联网，你们让我无中生有地了解了安卓“活动” `Activity` +- ……每个人都是好样的！ diff --git a/TODO b/TODO index e036e72..8004093 100644 --- a/TODO +++ b/TODO @@ -1,5 +1,10 @@ -+ Summary the hacks to p4a, bleak p4a recipe, p4a webview bootstrap, and AdvancedWebView ++ Hacky text printing, typewriter-like, with PF2 font ++ Better MTU/freq moderation ++ Better CLI, e.g. invoke imagemagick if input is not PBM ++ (Re-)support CUPS & IPP ++ Make a build guide for android: + Summary the hacks to p4a, bleak p4a recipe, p4a webview bootstrap, and AdvancedWebView + More frontend usability, more functions + A better layout for mobile? + Better Canvas mode, (re-)consider fabric.js @@ -7,3 +12,7 @@ + Write good help/manual + Make error notice short while let users see detailed help/manual for what-to-do + ... + +? Compression for GB03 data +? Put Android APP on F-Droid? But it needs automatic build system... + Android guys can help this!