From 05423ec531b39f751f0c63d80b144c9411113bc6 Mon Sep 17 00:00:00 2001 From: Gary Wang Date: Sat, 28 Mar 2026 15:09:13 +0800 Subject: [PATCH] chore: update README for 0.2.0 release --- README.md | 38 ++++++++++++++++++--- README.zh_CN.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 122 insertions(+), 4 deletions(-) create mode 100644 README.zh_CN.md diff --git a/README.md b/README.md index 2637feb..9d92131 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ Pineapple Notepad aims to be a simple, lightweight, and easy to use notepad application that can be a cross-platform alternative to Notepad++. It's based on [Scintilla](https://www.scintilla.org/), [Qt](https://www.qt.io/) and [KDE Framework](https://develop.kde.org/products/frameworks/), available on Windows, Linux[^7] and macOS[^8]. [^7]: Before reaching the Open Source sponsor goal, it will only available on deepin 25 amd64 version. Please consider become a sponsor to make me be able to reach the Open Source goal so it will be available on more distros and make porting possible. -[^8]: Available in later updates. Bundle will not be signed. +[^8]: Available since `0.2.0`. Bundle will not be signed. ## Pricing Pineapple Notepad itself is free of charge, even for commercial purposes. Please review `LICENSE` file for details. -Note that it's *currently* closed source. See the "Open Source Goal" section if you want to support Pineapple Notepad and make it open source. +Note that it's *currently* closed source. See the "Open Source Goal" section if you want to support Pineapple Notepad and make it open source. Please consider donate! ## Feature Comparation Table @@ -26,14 +26,16 @@ Note that it's *currently* closed source. See the "Open Source Goal" section if | Customizable Toolbar | ✅ | ❌ | ❌ | ❌ | ✅ | | Macro Recording | ✅ | ✅ | ✅ | ✅ | ❌ | | Change History | ✅ | ✅ | ❌ | ✅ | ✅ | +| Smart Highlight [^9] | ✅ | ✅ | ✅ | ✅ | ✅ | | Editor Engine | Scintilla | Scintilla | Scintilla | QScintilla | KTextEdit | -[^1]: Currently not released yet. Planned to be Open Source once Open Source Sponsor Goal is reached. +[^1]: Currently not open-sourced. Planned to be Open Source once Open Source Sponsor Goal is reached (please consider donate!). [^2]: Some non-printable characters are not able to be shown. [^3]: Some components have known issues with Hi-DPI support. [^4]: Available as custom-tailored docking system. [^5]: I created an add-on for this feature, but currently showing line ending is not possible to implement. [^6]: Not planned in the initial release, might be added in the future. +[^9]: Highlight selected word in the editor. ## Open Source Goal @@ -41,7 +43,35 @@ Pineapple Notepad is currently not an open source project, but the goal is to ma ### Sponsor Benefits -Before the goal is reached, if you support Pineapple Notepad for equial or more than $10, you will be credited within the application's About dialog as a kickstart supporter. The name will be kept for at least 10 releases, after that, the name might be moved a standalone `THANKS` file in the source repository. +Before the goal is reached, if you support Pineapple Notepad for equial or more than $10, you can be credited within the application's About dialog as a kickstart supporter. + +Please read the following details for sponsor benefits and possible restrictions. + +
+ +All listed benefits below only apply to sponsors who donate **before** we reach the Open Source goal. One-time donation is okay, no subscription needed. + +#### Tier 1: 10 USD + +- Get pre-released builds of Pineapple Notepad. +- You (individual) will be credited within the application's About dialog as a kickstart supporter. + - The name will be kept for at least 10 releases, after that, the name might be moved a standalone `THANKS` file in the source repository. + - Optional email and/or home page could be provided. + - Restriction applies (Please reach out if you have any questions or not sure if it applies to you): + - The name, email and/or link to your home page should not contain political content, any emoji or other contents might cause me trouble. + +#### Tier 2: 35 USD + +- All benefits of Tier 1 +- Get full source code of Pineapple Notepad that allows you build it from source or audit it. +- You (company/organization) will be credited within the application's About dialog as a sponsor. + - The name will be kept for at least 10 releases, after that, the name might be moved a standalone `THANKS` file in the source repository. + - Optional email and/or home page could be provided. + - Restriction applies (Please reach out if you have any questions or not sure if it applies to you): + - The name, email and/or link to your home page should not contain political content, any emoji or other contents might cause me trouble. + - Gambling, blockchain, adult content and/or other similar contents are not allowed. + +
*If you have questions about sponsor benefits, please reach out to me by creating an issue or drop me a message on Ko-fi or any other form that can be reached.* diff --git a/README.zh_CN.md b/README.zh_CN.md new file mode 100644 index 0000000..dd4a43c --- /dev/null +++ b/README.zh_CN.md @@ -0,0 +1,88 @@ +# 菠萝记事本 + +菠萝记事本致力于成为一个简单、轻量且易于使用的记事本应用程序，可以作为 Notepad++ 的跨平台替代品。它基于 [Scintilla](https://www.scintilla.org/)、[Qt](https://www.qt.io/) 和 [KDE Framework](https://develop.kde.org/products/frameworks/)，可在 Windows、Linux[^7] 和 macOS[^8] 上使用。 + +[^7]: 在达到开源赞助目标之前，它将仅在 deepin 25 amd64 版本上可用。请考虑成为赞助者，使我能够达到开源目标，这样它将在更多发行版上可用，并使移植成为可能。 +[^8]: 从 `0.2.0` 版本开始可用。捆绑包将不会被签名。 + +## 定价 + +菠萝记事本本身是免费的，包括商业用途在内。请查看 `LICENSE` 文件了解详情。 + +请注意，此项目*目前*是闭源的。如果您想支持菠萝记事本并使其开源，请参阅"开源目标"部分。请考虑捐赠！ + +## 功能比较表 + +| 功能 | `菠萝记事本` | `Notepad++` | `Notepad Next` | `Notepad--` | `Kate` | +| ------- | ------------------- | ----------- | -------------- | ----------- | ------ | +| 开源 | ❔[^1] | ✅ | ✅ | ❌ | ✅ | +| 跨平台 | ✅ | ❌ (仅 Windows) | ✅ | ✅ | ✅ | +| 文本编码 | ✅ | ✅ | ❌ | ✅ | ✅ | +| 显示所有字符 | ✅ | ✅ | ⚠️[^2] | ⚠️[^2] | ❌[^5] | +| 会话恢复 | ✅ | ✅ | ✅ | ✅ | ✅ | +| 高分辨率支持 | ✅ | ⚠️[^3] | ✅ | ⚠️[^3] | ✅ | +| 深色主题支持 | ✅ | ✅ | ❌ | ❌ | ✅ | +| 并排视图 | ❌[^6] | ✅ | ⚠️[^4] | ❌ | ✅ | +| 可自定义工具栏 | ✅ | ❌ | ❌ | ❌ | ✅ | +| 宏录制 | ✅ | ✅ | ✅ | ✅ | ❌ | +| 更改历史 | ✅ | ✅ | ❌ | ✅ | ✅ | +| 智能高亮 [^9] | ✅ | ✅ | ✅ | ✅ | ✅ | +| 编辑器引擎 | Scintilla | Scintilla | Scintilla | QScintilla | KTextEdit | + +[^1]: 目前未开源。计划在达到开源赞助目标后开源（请考虑捐赠！）。 +[^2]: 某些不可打印字符无法显示。 +[^3]: 某些组件在高分辨率支持方面存在已知问题。 +[^4]: 可作为自定义停靠系统使用。 +[^5]: 我为此功能创建了一个插件，但目前无法实现显示行尾符。 +[^6]: 初始版本中未计划，可能会在未来添加。 +[^9]: 在编辑器中高亮选中的单词。 + +## 开源目标 + +菠萝记事本目前不是一个开源项目，但目标是使菠萝记事本成为开源软件。我已设定了一个 1000 元的开源目标，如果达到该目标，Pineapple Notepad 将作为开源项目发布。请阅读[这篇文章](https://ko-fi.com/post/Pineapple-Notepad-A-Cross-platform-Notepad--Alte-G2G71V8JPX)了解详情。如果您有兴趣，请使用以下链接支持此项目。 + +### 赞助权益 + +在达到目标之前，如果您支持菠萝记事本达到或超过 50 元，您可以让您的名字出现在应用程序的"关于"对话框的特别致谢中。 + +请阅读以下详情了解赞助权益和可能的限制。 + +
+ +下面列出的所有权益仅适用于在达到开源目标**之前**捐赠的赞助者。 + +#### 第 1 档：50 元 + +- 获取菠萝记事本的预发布版本。 +- 您（个人）将在应用程序的"关于"对话框中被列为启动支持者。 + - 该名称将保留至少 10 个版本，之后可能会移动到源代码仓库中的独立 `THANKS` 文件。 + - 可以提供可选的电子邮件和/或主页。 + - 适用限制（如果您有任何疑问或不确定是否适用于您，请联系我）： + - 您的名称、电子邮件和/或主页链接不应包含政治内容、任何表情符号或其他可能给我带来麻烦的内容。 + +#### 第 2 档：35 美元 + +- 第 1 档的所有权益 +- 获取菠萝记事本的完整源代码，允许您从源代码构建或进行审计。 +- 您（公司/组织）将在应用程序的"关于"对话框中被列为赞助者。 + - 该名称将保留至少 10 个版本，之后可能会移动到源代码仓库中的独立 `THANKS` 文件。 + - 可以提供可选的电子邮件和/或主页。 + - 适用限制（如果您有任何疑问或不确定是否适用于您，请联系我）： + - 您的名称、电子邮件和/或主页链接不应包含政治内容、任何表情符号或其他可能给我带来麻烦的内容。 + - 恕不接受赌博、区块链、成人内容和/或其他类似内容。 + +
+ +*如果您对赞助权益有任何疑问，请通过创建 Issue 或在 Ko-fi 上给我留言或其他任何可以联系到我的方式与我取得联系。* + +### 资助 + +[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/blumia) + +[![爱发电](https://static.afdiancdn.com/static/img/logo/logo.png)爱发电](https://afdian.com/a/BLumia) + +## 许可证 + +菠萝记事本根据《菠萝记事本最终用户许可协议》发布。 + +达到开源目标后，此部分将更新。