trufont 0.6.6

入门指南

1. 安装 Python 3.6（或更高版本）

   • OS X：使用Homebrew安装： brew install python3

   • Windows：从python.org/downloads下载安装程序

   • Linux：通常与操作系统捆绑在一起。

2. 设置新的Python 虚拟环境。虽然这不是必需的，但强烈推荐这样做，因为TruFont有许多依赖项，这些依赖项可能与您全局安装的其他模块冲突。

   • 在 ENV_DIR 中创建新的虚拟环境

     python3 -m venv ENV_DIR

     这将在ENV_DIR文件夹中创建一个新的文件夹（您可以选择想要的名字）。bin子文件夹（或Windows上的Scripts）中包含一个新的python可执行文件，并且有一个指向它的pip安装程序。

   • 激活新创建的环境

     • OS X或Linux: source ENV_DIR/bin/activate

     • Windows: ENV_DIR\Scripts\activate.bat

     这暂时将虚拟环境脚本文件夹添加到您的控制台PATH中，因此您可以从任何地方访问python、pip和trufont脚本。

   • 当您想要退出虚拟环境时运行deactivate。这将恢复默认系统PATH。

3. 安装/更新 TruFont 到最新稳定版本

   pip install --upgrade trufont

4. 以trufont运行应用程序。

贡献

如果您想为TruFont做出贡献，这里有一个快速教程。

1. 点击上面的“Fork”按钮，并将克隆的git仓库克隆到名为trufont的新目录。

   git clone https://github.com/<YOUR_USERNAME>/trufont

2. 进入新文件夹并运行此命令以将上游仓库URL添加到本地远程列表

   git remote add upstream https://github.com/trufont/trufont

   这使您能够跟上上游的发展。

4. 在创建新分支之前，请将您的分支的master分支与upstream/master同步

   git checkout master
   git fetch upstream
   git rebase upstream/master
   git push

5. 安装pre-commit。每次您准备提交某些内容时，它都会运行一些检查。

   pip install pre-commit
   pre-commit install

5. 现在，您可以创建并切换到您的新功能分支

   git checkout -b my-cool-new-feature

6. 使用pip以“可编辑”模式安装TruFont

   pip install --editable .

   此命令不是将trufont复制到您的Python site-packages目录，而是仅在该git仓库内部源目录中创建一个链接。然后您可以直接修改代码，或同步最新的上游更改（如步骤4所示），而无需重新安装。

7. 还建议定期更新依赖项到当前测试版本，这些版本在requirements.txt中列出

   pip install --upgrade -r requirements.txt

8. 一旦提交了您的补丁，将新分支推送到您的分支

   git push -u origin my-cool-new-feature

9. 最后，点击TruFont的Github页面上的“新建拉取请求”以提交您的补丁。

我们将很高兴审查并整合它到主应用程序中。

祝您使用TruFont愉快！:muscle