获取源码
注:该文档中均使用 $AKMC_PATH
来指代 MISA-AKMC 源码目录
1. 获取源码¶
你可以使用以下任意一种方式获取代码:git clone、下载源码包。 如果你已经拥有源代码,可以忽略此步骤,直接跳到安装依赖小节。
1.1 git clone¶
如果你的系统中安装了 git 工具,可以使用 git clone 来拷贝仓库到本地。 这样的好处是,你可以随时切换使用其他任意版本的代码。
git clone https://github.com/misa-kmc/misa-akmc.git # https
或者,如果你配置了ssh key, 也可以使用 ssh 协议进行 clone:
git clone git@github.com:misa-kmc/misa-akmc.git # ssh
上述 git clone 命令会创建一个名为 kmc 的目录。 克隆完成后,你可以选择通过调用以下命令来构建特定分支(如版本分支)
$ cd $AKMC_PATH # MISA-AKMC 源码目录
$ git checkout Branch_Or_Tag
# where ' Branch_Or_Tag' is the desired branch or tag.
git checkout v0.1.0
.
Tip
开发组的人员可以通过以下地址进行 git clone 操作:
git clone https://git.hpcer.dev/HPCer/misa-akmc/kmc.git
或者 git clone ssh://git@git.hpcer.dev:2222/HPCer/misa-akmc/kmc.git
1.2 下载源码包¶
目前,MISA-AKMC 代码仓库托管于 github 上, 可以前往 github 代码仓库 进行源代码的下载。 更多关于开发进展、issue 等相关信息,也可在此查看。
2. 安装依赖¶
获取的源码中不包含该程序的依赖包,所以还需要额外的工作来安装依赖。
MISA-AKMC 依赖于一些开源库, 如kiwi,
googletest, xoshiro, libcomm等。
可以使用pkg依赖管理工具下载依赖包或者直接将对应依赖包导入到 MISA-AKMC 源码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 $AKMC_PATH
PKG_AUTH=username?token@git.hpcer.dev pkg fetch
pkg install
2.2 使用 pkg 导入依赖包¶
假设依赖压缩包文件名为: vendor-20190725-003851.426644.tar, 可以通过以下 pkg 命令导入依赖包:
cd $AKMC_PATH
pkg import --input vendor-20190725-003851.426644.tar
pkg fetch
pkg install
Note
针对 MISA-AKMC 目前 master 分支的代码(commit id: fad9250),可以前往 OSDN 下载依赖压缩包文件。
2.3 直接解压依赖包¶
直接导入依赖是将已有的依赖压缩包解压解压 MISA-AKMC 的源码的 vendor
目录。
假设依赖压缩包文件名为:vendor-20190725-003851.426644.tar, 可以通过以下命令加入依赖包:
mkdir -p $AKMC_PATHAKMC_PATH/vendor
cd $AKMC_PATH/vendor
tar xvf path/of/vendor-20200725-003851.426644.tar # tar to direcooty.