From b4e34f8d31511796baa7706ae655ee8ac0382b37 Mon Sep 17 00:00:00 2001 From: James Takai / hach1yon <32596618+hach1yon@users.noreply.github.com> Date: Sat, 25 Dec 2021 10:17:42 +0900 Subject: [PATCH] update readme --- README-English.md | 13 +++++-------- README-Japanese.md | 13 +++++-------- logs/DO_NOT_DELETE_THIS | 1 + 3 files changed, 11 insertions(+), 16 deletions(-) create mode 100644 logs/DO_NOT_DELETE_THIS diff --git a/README-English.md b/README-English.md index 215ff84e..f4bc9615 100644 --- a/README-English.md +++ b/README-English.md @@ -80,7 +80,10 @@ git clone https://github.com/Yamato-Security/hayabusa.git You can also manually download and extract Hayabusa from [https://github.com/Yamato-Security/hayabusa](https://github.com/Yamato-Security/hayabusa). -After that, you need to download a pre-compiled binary for the Windows, Linux or macOS at the [Releases](https://github.com/Yamato-Security/hayabusa/releases) page and save it to the `hayabusa` root folder. +After that, you need to download a pre-compiled binary for Windows or macOS at the [Releases](https://github.com/Yamato-Security/hayabusa/releases) page and save it to the `hayabusa\bin` folder. + +There are two different versions of the evtx library being used when compiled: `0.6.7` and `0.7.2`. +The `0.7.2` version should work but we have only tested it with `0.6.7` so please use that version if you experience any problems with `0.7.2`. # Compiling from source (Optional) If you have rust installed, you can compile from source with the following command: @@ -110,13 +113,7 @@ git clone https://github.com/Yamato-Security/hayabusa-sample-evtx.git > Note: You need to run the binary from the Hayabusa root directory. # Usage -You need to run the binary from the Hayabusa root directory. -There are different binary versions in `.\bin` compiled for different operating systems and architectures. -Also, there are two different versions of the evtx library being used when compiled: `0.6.7` and `0.7.2`. -The `0.7.2` version should work but we have only tested it with `0.6.7` so please use that if you experience any problems with `0.7.2`. -Please replace `hayabusa.exe` in the examples below with the appropriate Hayabusa binary filename. - -> Note: You need to run the Hayabusa binary from the Hayabusa root directory. +> Note: You need to run the Hayabusa binary from the Hayabusa root directory. Example: `.\bin\hayabusa.exe` ## Command line options ```bash diff --git a/README-Japanese.md b/README-Japanese.md index cd0bfc0e..cc215ca5 100644 --- a/README-Japanese.md +++ b/README-Japanese.md @@ -81,7 +81,10 @@ git clone https://github.com/Yamato-Security/hayabusa.git または、手動で[https://github.com/Yamato-Security/hayabusa](https://github.com/Yamato-Security/hayabusa)からHayabusaをダウンロードすることもできます。 -その後、Windows、Linux、macOS用のコンパイル済みバイナリを[Releases](https://github.com/Yamato-Security/Hayabusa/releases)からダウンロードして、`hayabusa`のディレクトリに置く必要があります。 +その後、Windows、macOS用のコンパイル済みバイナリを[Releases](https://github.com/Yamato-Security/Hayabusa/releases)からダウンロードして、`hayabusa\bin`のディレクトリに置く必要があります。 + +evtxライブラリのバージョン(`0.6.7`と`0.7.2`)毎に、コンパイルされたバイナリが用意されています。 +`0.7.2`バージョンでも動作するはずですが、`0.6.7`でしかテストしていませんので、`0.7.2`で問題が発生した場合はそちらをご利用ください。 # ソースコードからのコンパイル（任意） rustがインストールされている場合、以下のコマンドでソースコードからコンパイルすることができます: @@ -111,13 +114,7 @@ git clone https://github.com/Yamato-Security/hayabusa-sample-evtx.git > ※ 以下の例でHayabusaを試したい方は、上記コマンドをhayabusaのルートフォルダから実行してください。 # 使用方法 -Hayabusaはルートディレクトリでバイナリを実行する必要があります。 -.\bin` には、OSやアーキテクチャごとにコンパイルされたバイナリが用意されています。 -また、evtxライブラリのバージョン(`0.6.7`と`0.7.2`)毎に、コンパイルされたバイナリが用意されています。 -`0.7.2`バージョンでも動作するはずですが、`0.6.7`でしかテストしていませんので、`0.7.2`で問題が発生した場合はそちらをご利用ください。 -以下の例の `hayabusa.exe` は、適切なHayabusaのバイナリファイル名に置き換えてください。 - -> 注意: Hayabusaのルートディレクトリから、バイナリを実行する必要があります。 +> 注意: Hayabusaのルートディレクトリから、バイナリを実行する必要があります。例：`.\bin\hayabusa.exe` ## コマンドラインオプション ```bash diff --git a/logs/DO_NOT_DELETE_THIS b/logs/DO_NOT_DELETE_THIS new file mode 100644 index 00000000..e10b6e56 --- /dev/null +++ b/logs/DO_NOT_DELETE_THIS @@ -0,0 +1 @@ +Don't delete this file. \ No newline at end of file