From 603e0171688a9be62deab42ce7ede478ffd29c33 Mon Sep 17 00:00:00 2001 From: Continuous Integration Date: Sat, 25 May 2024 05:30:53 +0000 Subject: [PATCH] Auto-translate README --- README.md | 1 + README.zh-CN.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 README.md create mode 100644 README.zh-CN.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b5c671 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +当前地区当日额度已消耗完, 请尝试更换网络环境 \ No newline at end of file diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 0000000..c55f1b3 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,37 @@ +# Autosink 项目的数据准备 + +[🇬🇧](README.md) | [🇰🇷](README.kr.md) | [🇨🇳](README.zh-CN.md) + +环境是基于 MacOS、Linux。 + +## `Makefile` + +`Makefile` 包含以下功能。 + +### `make lint` + +- 若要使用 `.vscode` 设置,请安装 `pylint` 扩展。 +- 通过覆盖 linter 的默认设置中在 `pyproject.toml` 文件中指定的选项来对代码进行 lint。 + +### `make format` + +- 使用 google 的 `yapf` 作为格式化工具。 +- 通过覆盖 `yapf` 格式化器的默认设置中在 `pyproject.toml` 文件中指定的选项来格式化代码。 +- 若要使用 `.vscode` 设置,请安装 `yapf` 扩展。 + +### `make test` + +- 使用 `unittest` 进行测试。 +- 支持 `test_*.py` 和 `*_test.py` 模式。 +- 测试文件必须通过 `__init__.py` 连接到测试文件所在的位置。 + +### `make publish` + +- 请按以下格式编写 `~/.pypirc` 文件。 + ``` + [pypi] + username = __token__ + password = pypi-xxxxxx # 请获取个人 API 令牌并填写 + ``` +- 运行此命令将使用 `flit` 将软件包推送到 PyPI 公共注册表。 +- 通过之前指定的名称 `myproject`(别名),软件包将被上传,任何人都可以通过 `python3 -m pip install myproject` 安装并使用软件包。 \ No newline at end of file