获取源代码

注：该文档中均使用 $MD_PATH 来指代Crystal MD源码目录。

1. 获取源码

你可以使用以下任意一种方式获取代码：git clone、下载源码包。 如果你已经拥有源代码，可以忽略此步骤，直接跳到安装依赖小节。

1.1 git clone

如果你的系统中安装了git工具，可以使用git来clone源代码。 这样的好处是，你可以随时切换使用其他任意版本的代码。

git clone https://git.hpcer.dev/HPCer/CrystalMD/CrystalMD.git # https

或者，如果你配置了ssh key, 也可以使用ssh协议进行clone:

git clone ssh://git@git.hpcer.dev:2222/HPCer/CrystalMD/CrystalMD.git # ssh

上述 git clone 命令会创建一个名为 Crystal MD 的目录。 克隆完成后，你可以选择通过调用以下命令来构建特定分支（如版本分支）

$ cd $MD_PATH # Crystal MD源码目录$ git checkout Branch_Or_Tag# where ' Branch_Or_Tag' is the desired branch or tag.

例如，要使用 v0.4.0 版本而不是主分支，可使用以下命令进行切换 git checkout v0.4.0.

1.2 直接下载源码包

使用wget命令或者在浏览器中下载源代码压缩包。
如，下载v0.4.0版本的源码包：

$ wget -O CrystalMD-v0.4.0.tat.gz \  https://git.hpcer.dev/HPCer/CrystalMD/CrystalMD/-/archive/v0.4.0/CrystalMD-v0.4.0.tar.gz$ tar -zxvf CrystalMD-v0.4.0.tar.gz

2. 安装依赖

获取的源码中不包含该程序的依赖包，所以还需要额外的工作来安装依赖。

Crystal MD 依赖于一些开源库, 如kiwi, googletest, fmt, args等。 可以使用pkg依赖管理工具下载依赖包或者直接将对应依赖包导入到Crystal MD源码vendor目录。

其中，pkg工具的安装见 https://github.com/genshen/pkg/。

以下三种依赖安装方式选择其一即可：

2.1 使用pkg安装依赖

使用该方式安装依赖，需要你的系统能够连接到互联网，且有所有依赖仓库的 git 克隆权限。 可以通过设置PKG_AUTH环境变量的方式指定获取相关私有仓库的口令， 如PKG_AUTH=username?token@git.hpcer.dev指定了获取位于git.hpcer.dev上的私有依赖库的用户名和认证token。

依赖安装：

cd $MD_PATHPKG_AUTH=username?token@git.hpcer.dev pkg fetchpkg install

2.2 使用pkg导入离线依赖包

如下依赖包的直接安装会因为网络等原因中断，可以考虑下载离线依赖包，然后进行导入。
假设依赖压缩包文件名为: vendor-20190725-003851.426644.tar, 可以通过以下pkg命令导入依赖包:

cd $MD_PATHpkg import --input vendor-20190725-003851.426644.tarpkg fetchpkg install

用户可以从 OSDN 上的 https://osdn.net/pkg/misa-md/dependencies 页面获取各个 MISA-MD 版本的依赖包，然后通过 pkg import 导入。 例如，如果需要下载 MISA—MD v0.4.0 版本对应的依赖包，可以通过链接 https://osdn.net/dl/misa-md/misamd-v0.4.0-vendor-20210413-160703.217989.tar 从OSDN 上下载。

2.3 直接解压依赖包

直接导入依赖是将已有的依赖压缩包解压解压Crystal MD的源码的vendor目录。

假设依赖压缩包文件名为：vendor-20190725-003851.426644.tar, 可以通过以下命令加入依赖包:

mkdir -p $MD_PATH/vendorcd $MD_PATH/vendortar xvf path/of/vendor-20190725-003851.426644.tar # tar to direcooty.