novelWriter 项目下载及安装教程

1、项目介绍

novelWriter 是一个开源的纯文本编辑器，专为撰写小说而设计。它支持一种类似于 Markdown 的简化语法，用于文本格式化，并使用 Python 3 (3.9+) 和 Qt 5 (5.15) 进行跨平台支持。novelWriter 旨在成为一个简单的文本编辑器，允许用户轻松组织文本和笔记，使用人类可读的文本文件作为存储，以确保稳健性。项目存储适用于版本控制软件，并且非常适合文件同步工具。所有文本都保存为带有元数据头的纯文本文件，核心项目结构存储在单个项目 XML 文件中，其他元数据主要保存为 JSON 文件。

2、项目下载位置

你可以通过以下链接下载 novelWriter 项目：

novelWriter GitHub 仓库

3、项目安装环境配置

3.1 系统要求

• 操作系统: Linux, Windows, macOS
• Python 版本: 3.9+
• Qt 版本: 5.15

3.2 安装 Python 3.9+

首先，确保你的系统上安装了 Python 3.9 或更高版本。你可以通过以下命令检查 Python 版本：

python3 --version

如果未安装，请访问 Python 官方网站 下载并安装。

3.3 安装 Qt 5.15

novelWriter 依赖于 Qt 5.15。你可以通过以下命令安装 Qt：

pip install PyQt5==5.15

3.4 环境配置示例

以下是一个简单的环境配置示例：

4、项目安装方式

4.1 克隆项目

使用 Git 克隆 novelWriter 项目到本地：

git clone https://github.com/vkbo/novelWriter.git

4.2 安装依赖

进入项目目录并安装所需的依赖：

cd novelWriter
pip install -r requirements.txt

4.3 运行项目

安装完成后，你可以通过以下命令运行 novelWriter：

python3 novelWriter.py

5、项目处理脚本

novelWriter 项目包含一些处理脚本，用于自动化任务和测试。以下是一些常用的脚本：

5.1 运行测试

你可以使用以下命令运行项目的测试：

pytest

5.2 生成文档

项目文档可以通过以下命令生成：

make docs

5.3 打包项目

你可以使用以下命令打包项目：

python setup.py sdist bdist_wheel

通过以上步骤，你应该能够成功下载、安装并运行 novelWriter 项目。如果你在安装过程中遇到任何问题，请参考项目的 GitHub Issues 页面或联系项目维护者。