From 41910c08136f16aaeb96f764f6e9471fa46505e8 Mon Sep 17 00:00:00 2001 From: itiB Date: Fri, 14 Jan 2022 00:33:43 +0900 Subject: [PATCH] Update: README for submodule --- README-English.md | 9 ++++++++- README-Japanese.md | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/README-English.md b/README-English.md index 9ddcc87d..d602562f 100644 --- a/README-English.md +++ b/README-English.md @@ -79,7 +79,14 @@ You can download the latest Hayabusa version from the [Releases](https://github. You can also `git clone` the repository with the following command and compile binary from source code.: ```bash -git clone https://github.com/Yamato-Security/hayabusa.git +git clone https://github.com/Yamato-Security/hayabusa.git --recursive +``` + +If you forget to use `--recursive` option, `rules/` files which managed in submodule did not cloned. +Use following command to import submodules. + +```bash +git submodule update --init ``` There are two different versions of the evtx library being used when compiled: `0.6.7` and `0.7.2`. diff --git a/README-Japanese.md b/README-Japanese.md index a71f21a6..22e89881 100644 --- a/README-Japanese.md +++ b/README-Japanese.md @@ -80,7 +80,14 @@ Hayabusaの[Releases](https://github.com/Yamato-Security/hayabusa/releases)か または、以下の`git clone`コマンドでレポジトリをダウンロードし、ソースコードからコンパイルして使用することも可能です。 ```bash -git clone https://github.com/Yamato-Security/hayabusa.git +git clone https://github.com/Yamato-Security/hayabusa.git --recursive +``` + +`--recursive` をつけ忘れた場合、サブモジュールとして管理されている `rules/` 内のファイルが取得できません。 +以下のコマンドでサブモジュールを取得してください。 + +```bash +git submodule update --init ``` evtxライブラリのバージョン(`0.6.7`と`0.7.2`)毎に、コンパイルされたバイナリが用意されています。