Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fksms committed Nov 30, 2024
1 parent d8884ee commit 99f198d
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 21 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
MIT License
The MIT License (MIT)

Copyright (c) 2024 Shogo Fukushima

Expand Down
21 changes: 11 additions & 10 deletions README-jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
スキャンを行うディレクトリやスキャンから除外するディレクトリの設定が可能です。<br>
フレームワークはTauriを利用しており、Linux、macOS、Windowsで動作します。<br>
フロントエンドの処理はVue3 + Javascript、バックエンドの処理はRustで書かれています。<br>
バックエンドは[dust](https://github.com/bootandy/dust)のコードをカスタマイズして利用しています。<br>

<br>
<img src="./images/ScreenRecording.gif" width="550">
Expand Down Expand Up @@ -68,50 +69,50 @@ Windowsの場合は以下からインストールも可能です。<br>
### MacOS

rustup-initとnodebrewをインストール
```
```sh
brew install rustup-init
brew install nodebrew
```

rustup-initとnodebrewのセットアップ
```
```sh
rustup-init
nodebrew setup
```

node.js(npm)の安定版をインストール
```
```sh
nodebrew install stable
nodebrew use stable
```

tauri-cliをインストール(v1を利用する)
```
```sh
cargo install tauri-cli --version "^1"
```

作業ディレクトリに移動
```
```sh
cd DirWalker
```

必要なパッケージをインストール(node_modulesが作成される)
```
```sh
npm install
```

Build & Preview(Debug)
```
```sh
cargo tauri dev
```

Build(Release)
```
```sh
cargo tauri build
```

Build(Debug)
```
```sh
cargo tauri build --debug
```

Expand All @@ -133,5 +134,5 @@ Issueへの投稿、PullRequest大歓迎です。
<br>

## License
MIT License<br>
The MIT License (MIT)<br>
Copyright (c) 2024 Shogo Fukushima
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This tool visualizes the usage rate of each directory using a sunburst chart.<br
You can configure which directories to scan and which directories to exclude from the scan.<br>
The framework used is Tauri, and it operates on Linux, macOS, and Windows.<br>
The frontend is implemented with Vue3 and JavaScript, while the backend is written in Rust.<br>
The backend uses customized [dust](https://github.com/bootandy/dust) code.<br>

<br>
<img src="./images/ScreenRecording.gif" width="550">
Expand Down Expand Up @@ -70,50 +71,50 @@ By manually running `All Build Debug`, you can build debug versions for MacOS, W
### MacOS

Install rustup-init and nodebrew
```
```sh
brew install rustup-init
brew install nodebrew
```

Setting up rustup-init and nodebrew
```
```sh
rustup-init
nodebrew setup
```

Install the stable version of node.js (npm)
```
```sh
nodebrew install stable
nodebrew use stable
```

Install tauri-cli (Use v1)
```
```sh
cargo install tauri-cli --version "^1"
```

Move to the working directory
```
```sh
cd DirWalker
```

Install the necessary packages (node_modules will be created)
```
```sh
npm install
```

Build & Preview (Debug)
```
```sh
cargo tauri dev
```

Build (Release)
```
```sh
cargo tauri build
```

Build (Debug)
```
```sh
cargo tauri build --debug
```

Expand All @@ -135,5 +136,5 @@ Since Japanese is the main language, English translations are also welcome.<br>
<br>

## License
MIT License<br>
The MIT License (MIT)<br>
Copyright (c) 2024 Shogo Fukushima

0 comments on commit 99f198d

Please sign in to comment.