xiboliya / snowpad Goto Github PK

软件名称：冰雪记事本
软件作者：冰原

代码仓库（皆采用git进行管理）：
GitHub：https://github.com/xiboliya/snowpad
Gitee：https://gitee.com/xiboliya/snowpad
GitCode：https://gitcode.net/chenzhengfeng/snowpad
Coding：https://xiboliya.coding.net/p/SnowPad/d/SnowPad/git

软件版权：
本项目是一个开源项目，遵循GNU GPL第三版开源许可协议的相关条款。协议具体条款详见licenses/GPLv3.txt文件。

软件编译：
本项目采用ant进行编译和打包。ant是目前java环境下最好用的打包部署工具，其采用xml的格式进行编写，功能非常强大。
现介绍一下如何安装和使用ant进行java程序的编译打包。

Windows系统：
1.下载并安装ant。
到官方主页http://ant.apache.org下载新版（撰写本文档时为Ant1.8.1）的ant，得到的是一个apache-ant-1.8.1-bin.zip的压缩包。将其解压到你的硬盘上，例如：D:\apache-ant-1.8.1。
2.配置环境变量。
不同系统打开环境变量的方式有所不同：
Windows XP系统下依次选择：我的电脑->属性->高级->环境变量。
Windows 7系统下依次选择：计算机->属性->高级系统设置->环境变量。
打开环境变量对话框之后，再依次选择：系统变量->Path->编辑->变量值，在最前面添加如下内容：
D:\apache-ant-1.8.1\bin;
然后点击“确定”，完成环境变量的配置。
3.验证ant。
为了验证ant是否成功安装，可以进行如下操作：
依次选择：开始->运行->cmd，输入如下命令：
ant
如果出现如下内容，说明安装成功：
Buildfile: build.xml does not exist!
Build failed
但如果出现如下内容，说明安装失败：（应重复前述步骤，直至安装成功。）
'ant' 不是内部或外部命令，也不是可运行的程序或批处理文件。
4.编译项目
假设本项目的路径为：D:\SnowPad，我们在命令行中cd到此路径下，然后输入如下命令：
ant
开始编译。编译完成后，当前目录下会产生一个ant目录。其中ant\bin目录存放编译产生的class文件和所需的资源文件（图片和配置文件等）。而ant\jar\SnowPad.jar文件即是我们需要的可运行的jar包。此jar文件可以直接双击运行，或者直接双击本项目根目录下的SnowPad.bat脚本文件运行，或者使用命令行：java -jar ant\jar\SnowPad.jar来运行。

Linux或macOS系统：
1.下载并安装ant。
到官方主页http://ant.apache.org下载新版（撰写本文档时为Ant1.8.1）的ant，得到的是一个apache-ant-1.8.1-bin.zip的压缩包。将其解压到你的硬盘上，例如：~/apache-ant-1.8.1。其中~即为当前用户的home目录的简写。
为了保证ant能够正常的执行，建议在终端中执行以下命令，添加可执行权限：
chmod -R +x ~/apache-ant-1.8.1
2.配置环境变量。
根据用户使用的shell不同，配置环境变量的方式有所不同：
如果使用的是bash，则新建或打开home目录下的.bashrc文件。
如果使用的是zsh，则新建或打开home目录下的.zshrc文件。
打开相应的rc文件之后，添加如下内容：
PATH=$PATH:~/apache-ant-1.8.1/bin
export PATH
注意：如果rc文件中已有自定义的PATH变量，则注意添加英文冒号（:）进行分隔。
rc文件保存后，由2种方式使配置生效：
可以执行如下命令使配置生效：
source .bashrc或source .zshrc
也可以直接退出终端，重新打开新的终端。
3.验证ant。
为了验证ant是否成功安装，可以进行如下操作：
在终端中输入如下命令：
ant
如果出现如下内容，说明安装成功：
Buildfile: build.xml does not exist!
Build failed
但如果出现如下内容，说明安装失败：（应重复前述步骤，直至安装成功。）
bash: command not found: ant或zsh: command not found: ant
4.编译项目
假设本项目的路径为：~/SnowPad，我们在终端中cd到此路径下，然后输入如下命令：
ant
开始编译。编译完成后，当前目录下会产生一个ant目录。其中ant/bin目录存放编译产生的class文件和所需的资源文件（图片和配置文件等）。而ant/jar/SnowPad.jar文件即是我们需要的可运行的jar包。此jar文件可以直接双击运行，或者直接双击本项目根目录下的SnowPad.bat脚本文件运行，或者使用命令行：java -jar ant/jar/SnowPad.jar来运行。