From 7628f96f9cc56cd1ad5ccf67b6ccf8b7a20a3b65 Mon Sep 17 00:00:00 2001 From: muzing Date: Tue, 16 Jan 2024 17:49:45 +0800 Subject: [PATCH] Update README --- README.md | 24 +++++++++--------------- README_zh.md | 16 +++++++--------- 2 files changed, 16 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index e6b78a0..54314d9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -![Py2exe-GUI Logo](https://raw.githubusercontent.com/muziing/Py2exe-GUI/main/docs/source/images/py2exe-gui_logo_big.png) +

+Py2exe-GUI Logo +

-

Easy-to-use Python GUI packaging tool

+

Python GUI packaging tool

GitHub Repo stars @@ -32,8 +34,7 @@ It has the following features: - Fully graphical interface, easy to use. - All options of PyInstaller will be supported. -- You can invoke any local Python interpreter with its corresponding environment, eliminating the need to reinstall it - in each interpreter environment to be packaged. +- You can invoke any local Python interpreter with its corresponding environment, eliminating the need to reinstall it in each interpreter environment to be packaged. - Cross-platform, supports Windows, Linux and macOS. ## How to install @@ -69,8 +70,7 @@ python -m py2exe_gui # `_`, not `-` ### Option B: Run through source code -For those who like to try it out or are in desperate need of the latest bug fixes, you can run it through the repository -source code: +For those who like to try it out or are in desperate need of the latest bug fixes, you can run it through the repository source code: 1. Download the [latest main branching source code](https://codeload.github.com/muziing/Py2exe-GUI/zip/refs/heads/main). @@ -97,13 +97,9 @@ source code: Py2exe-GUI is a free and open source software and anyone is welcome to contribute to its development. -If you encounter any problems while using it (including -bugs, typos, etc.), or if you have suggestions for new features, you can open -an [issue](https://github.com/muziing/Py2exe-GUI/issues/new). +If you encounter any problems while using it (including bugs, typos, etc.), or if you have suggestions for new features, you can open an [issue](https://github.com/muziing/Py2exe-GUI/issues/new). -If you are able to contribute code, feel free to submit a pull-request. -Please follow the original code style as much as possible, and make sure that the new code passes all -the [checks](dev_scripts/check_funcs.py). +If you have the willingness and ability to contribute code, please read the [contribution guidance](.github/CONTRIBUTING.md) for more details. ## License @@ -111,9 +107,7 @@ the [checks](dev_scripts/check_funcs.py). Py2exe-GUI is licensed under the GPLv3 open source license, see the [LICENSE](LICENSE) file for details. -There is one exception: if your project uses Py2exe-GUI only as a packaging tool, and your final distribution does not -contain Py2exe-GUI's source code or binaries, then your project is not restricted by the GPLv3 restrictions and can -still be distributed as closed-source commercial software. +There is one exception: if your project uses Py2exe-GUI only as a packaging tool, and your final distribution does not contain Py2exe-GUI's source code or binaries, then your project is not restricted by the GPLv3 restrictions and can still be distributed as closed-source commercial software. ```text Py2exe-GUI diff --git a/README_zh.md b/README_zh.md index c2dc6a9..71568e4 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,4 +1,6 @@ -![Py2exe-GUI Logo](https://raw.githubusercontent.com/muziing/Py2exe-GUI/main/docs/source/images/py2exe-gui_logo_big.png) +

+Py2exe-GUI Logo +

强大易用的 Python 图形界面打包工具

@@ -20,8 +22,7 @@ ## 简介 -Py2exe-GUI 是一个基于 [PySide6](https://doc.qt.io/qtforpython/index.html) -开发的辅助工具，旨在为 [PyInstaller](https://pyinstaller.org/) 提供完整易用的图形化界面，方便用户进行 Python 项目的打包。 +Py2exe-GUI 是一个基于 [PySide6](https://doc.qt.io/qtforpython/index.html) 开发的辅助工具，旨在为 [PyInstaller](https://pyinstaller.org/) 提供完整易用的图形化界面，方便用户进行 Python 项目的打包。 ![界面截图](https://raw.githubusercontent.com/muziing/Py2exe-GUI/main/docs/source/images/Py2exe-GUI_v0.3.0_mainwindow_screenshot.png) @@ -93,11 +94,9 @@ python -m py2exe_gui # 注意连字符为_ Py2exe-GUI 是一个自由的开源软件，欢迎任何人为其开发贡献力量。 -如果你在使用时遇到任何问题（包括 -bug、界面错别字等），或者提议新增实用功能，可以提交一个 [issue](https://github.com/muziing/Py2exe-GUI/issues/new)。 +如果你在使用时遇到任何问题（包括 bug、界面错别字等），或者提议新增实用功能，可以提交一个 [issue](https://github.com/muziing/Py2exe-GUI/issues/new)。 -如果你有能力有想法贡献代码，欢迎提交 pull -request。请尽可能遵守原有的代码风格，并确保新增代码能通过[静态检查](dev_scripts/check_funcs.py)。 +如果你有能力有想法贡献代码，请阅读[贡献指南](.github/CONTRIBUTING.md)了解更多详情。 ## 开源许可 @@ -105,8 +104,7 @@ request。请尽可能遵守原有的代码风格，并确保新增代码能通 Py2exe-GUI 采用 GPLv3 开源许可证，详情请参见 [LICENSE](LICENSE) 文件。 -但有一个例外：如果你的项目仅使用 Py2exe-GUI 作为打包工具，而最终发布的软件中并不包含 Py2exe-GUI 的源码或二进制文件，那么你的项目不会受到 -GPLv3 的限制，仍可作为闭源商业软件发布。 +但有一个例外：如果你的项目仅使用 Py2exe-GUI 作为打包工具，而最终发布的软件中并不包含 Py2exe-GUI 的源码或二进制文件，那么你的项目不会受到 GPLv3 的限制，仍可作为闭源商业软件发布。 ```text Py2exe-GUI