Skip to content

Commit b5a8b05

Browse files
hj4645hj4645
committed
docs: readme 수정
1 parent e0c969f commit b5a8b05

4 files changed

Lines changed: 160 additions & 28 deletions

File tree

‎README.md‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,50 @@ dependencies {
6161

6262
### 1. 라이브러리 설치 후 CLI 사용
6363

64-
라이브러리를 dependency로 추가한 후, alias를 설정하여 CLI로 사용할 수 있습니다:
64+
라이브러리를 dependency로 추가한 후, alias를 설정하여 CLI로 사용할 수 있습니다.
6565

66+
#### 🚀 간편한 alias 설정 방법
67+
68+
**macOS/Linux:**
69+
```bash
70+
# 한 번에 alias 설정하기
71+
echo "alias cch=\"java -jar \$(find ~/.gradle/caches -name \"*commit-chronicle*\" -type f | grep \"\.jar$\" | head -1)\"" >> ~/.zshrc && source ~/.zshrc
72+
73+
# 또는 단계별로 설정
74+
JAR_PATH=$(find ~/.gradle/caches -name "*commit-chronicle*" -type f | grep "\.jar$" | head -1)
75+
echo "alias cch=\"java -jar $JAR_PATH\"" >> ~/.zshrc
76+
source ~/.zshrc
77+
```
78+
79+
**Windows (PowerShell):**
80+
```powershell
81+
# JAR 파일 경로 찾기
82+
$jarPath = Get-ChildItem -Path "$env:USERPROFILE\.gradle\caches" -Recurse -Name "*commit-chronicle*.jar" | Select-Object -First 1
83+
$fullPath = Join-Path "$env:USERPROFILE\.gradle\caches" $jarPath
84+
85+
# alias 설정
86+
echo "function cch { java -jar `"$fullPath`" @args }" >> $PROFILE
87+
. $PROFILE
88+
```
89+
90+
#### 수동 설정 방법
91+
92+
**JAR 파일 경로 확인:**
6693
```bash
67-
# Gradle 캐시에서 JAR 파일 경로 확인
68-
find ~/.gradle/caches -name "commitchronicle-1.0.0.jar" -type f
94+
# macOS/Linux
95+
find ~/.gradle/caches -name "*commit-chronicle*" -type f | grep "\.jar$"
6996

70-
# alias 설정 (예시 - 실제 경로로 수정 필요)
71-
alias cch="java -jar ~/.gradle/caches/modules-2/files-2.1/com.github.hj4645/commit-chronicle/1.0.0/*/commitchronicle-1.0.0.jar"
97+
# Windows (PowerShell)
98+
Get-ChildItem -Path "$env:USERPROFILE\.gradle\caches" -Recurse -Name "*commit-chronicle*.jar"
99+
```
100+
101+
**alias 설정:**
102+
```bash
103+
# macOS/Linux
104+
alias cch="java -jar /실제/jar/파일/경로/commit-chronicle-1.0.0.jar"
72105

73-
# 또는 직접 다운로드한 JAR 파일 사용
74-
alias cch="java -jar /path/to/commitchronicle-1.0.0.jar"
106+
# Windows (PowerShell)
107+
function cch { java -jar "C:\실제\jar\파일\경로\commit-chronicle-1.0.0.jar" @args }
75108
```
76109
77110
### 2. 초기 설정

‎README_EN.md‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,50 @@ dependencies {
6161

6262
### 1. Using as Library for CLI
6363

64-
After adding the library as a dependency, you can set up an alias to use it as CLI:
64+
After adding the library as a dependency, you can set up an alias to use it as CLI.
6565

66+
#### 🚀 Easy Alias Setup Method
67+
68+
**macOS/Linux:**
69+
```bash
70+
# One-liner alias setup
71+
echo "alias cch=\"java -jar \$(find ~/.gradle/caches -name \"*commit-chronicle*\" -type f | grep \"\.jar$\" | head -1)\"" >> ~/.zshrc && source ~/.zshrc
72+
73+
# Or step-by-step setup
74+
JAR_PATH=$(find ~/.gradle/caches -name "*commit-chronicle*" -type f | grep "\.jar$" | head -1)
75+
echo "alias cch=\"java -jar $JAR_PATH\"" >> ~/.zshrc
76+
source ~/.zshrc
77+
```
78+
79+
**Windows (PowerShell):**
80+
```powershell
81+
# Find JAR file path
82+
$jarPath = Get-ChildItem -Path "$env:USERPROFILE\.gradle\caches" -Recurse -Name "*commit-chronicle*.jar" | Select-Object -First 1
83+
$fullPath = Join-Path "$env:USERPROFILE\.gradle\caches" $jarPath
84+
85+
# Set up alias
86+
echo "function cch { java -jar `"$fullPath`" @args }" >> $PROFILE
87+
. $PROFILE
88+
```
89+
90+
#### Manual Setup Method
91+
92+
**Find JAR file path:**
6693
```bash
67-
# Find JAR file path in Gradle cache
68-
find ~/.gradle/caches -name "commitchronicle-0.1.0.jar" -type f
94+
# macOS/Linux
95+
find ~/.gradle/caches -name "*commit-chronicle*" -type f | grep "\.jar$"
6996

70-
# Set up alias (example - modify with actual path)
71-
alias cch="java -jar ~/.gradle/caches/modules-2/files-2.1/com.github.hj4645/commit-chronicle/1.0.0/*/commitchronicle-1.0.0.jar"
97+
# Windows (PowerShell)
98+
Get-ChildItem -Path "$env:USERPROFILE\.gradle\caches" -Recurse -Name "*commit-chronicle*.jar"
99+
```
100+
101+
**Set up alias:**
102+
```bash
103+
# macOS/Linux
104+
alias cch="java -jar /actual/jar/file/path/commit-chronicle-1.0.0.jar"
72105

73-
# Or use directly downloaded JAR file
74-
alias cch="java -jar /path/to/commitchronicle-0.1.0.jar"
106+
# Windows (PowerShell)
107+
function cch { java -jar "C:\actual\jar\file\path\commit-chronicle-1.0.0.jar" @args }
75108
```
76109
77110
### 2. Initial Setup

‎README_JA.md‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,50 @@ dependencies {
6161

6262
### 1. ライブラリとしてCLI使用
6363

64-
依存関係を追加後、エイリアスを設定してCLIとして使用できます：
64+
依存関係を追加後、エイリアスを設定してCLIとして使用できます。
6565

66+
#### 🚀 簡単なエイリアス設定方法
67+
68+
**macOS/Linux:**
69+
```bash
70+
# ワンライナーでエイリアス設定
71+
echo "alias cch=\"java -jar \$(find ~/.gradle/caches -name \"*commit-chronicle*\" -type f | grep \"\.jar$\" | head -1)\"" >> ~/.zshrc && source ~/.zshrc
72+
73+
# またはステップ別設定
74+
JAR_PATH=$(find ~/.gradle/caches -name "*commit-chronicle*" -type f | grep "\.jar$" | head -1)
75+
echo "alias cch=\"java -jar $JAR_PATH\"" >> ~/.zshrc
76+
source ~/.zshrc
77+
```
78+
79+
**Windows (PowerShell):**
80+
```powershell
81+
# JARファイルパスを検索
82+
$jarPath = Get-ChildItem -Path "$env:USERPROFILE\.gradle\caches" -Recurse -Name "*commit-chronicle*.jar" | Select-Object -First 1
83+
$fullPath = Join-Path "$env:USERPROFILE\.gradle\caches" $jarPath
84+
85+
# エイリアス設定
86+
echo "function cch { java -jar `"$fullPath`" @args }" >> $PROFILE
87+
. $PROFILE
88+
```
89+
90+
#### 手動設定方法
91+
92+
**JARファイルパス確認：**
6693
```bash
67-
# Gradleキャッシュ内のJARファイルパスを確認
68-
find ~/.gradle/caches -name "commitchronicle-0.1.0.jar" -type f
94+
# macOS/Linux
95+
find ~/.gradle/caches -name "*commit-chronicle*" -type f | grep "\.jar$"
6996

70-
# エイリアス設定（例 - 実際のパスに修正が必要）
71-
alias cch="java -jar ~/.gradle/caches/modules-2/files-2.1/com.github.hj4645/commit-chronicle/v0.1.0/*/commitchronicle-0.1.0.jar"
97+
# Windows (PowerShell)
98+
Get-ChildItem -Path "$env:USERPROFILE\.gradle\caches" -Recurse -Name "*commit-chronicle*.jar"
99+
```
100+
101+
**エイリアス設定：**
102+
```bash
103+
# macOS/Linux
104+
alias cch="java -jar /実際の/jar/ファイル/パス/commit-chronicle-1.0.0.jar"
72105

73-
# または直接ダウンロードしたJARファイルを使用
74-
alias cch="java -jar /path/to/commitchronicle-0.1.0.jar"
106+
# Windows (PowerShell)
107+
function cch { java -jar "C:\実際の\jar\ファイル\パス\commit-chronicle-1.0.0.jar" @args }
75108
```
76109
77110
### 2. 初期設定

‎README_ZH.md‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,50 @@ dependencies {
6161

6262
### 1. 作为库使用CLI
6363

64-
添加依赖后，可以设置别名来使用CLI：
64+
添加依赖后，可以设置别名来使用CLI。
6565

66+
#### 🚀 简便的别名设置方法
67+
68+
**macOS/Linux:**
69+
```bash
70+
# 一键设置别名
71+
echo "alias cch=\"java -jar \$(find ~/.gradle/caches -name \"*commit-chronicle*\" -type f | grep \"\.jar$\" | head -1)\"" >> ~/.zshrc && source ~/.zshrc
72+
73+
# 或分步设置
74+
JAR_PATH=$(find ~/.gradle/caches -name "*commit-chronicle*" -type f | grep "\.jar$" | head -1)
75+
echo "alias cch=\"java -jar $JAR_PATH\"" >> ~/.zshrc
76+
source ~/.zshrc
77+
```
78+
79+
**Windows (PowerShell):**
80+
```powershell
81+
# 查找JAR文件路径
82+
$jarPath = Get-ChildItem -Path "$env:USERPROFILE\.gradle\caches" -Recurse -Name "*commit-chronicle*.jar" | Select-Object -First 1
83+
$fullPath = Join-Path "$env:USERPROFILE\.gradle\caches" $jarPath
84+
85+
# 设置别名
86+
echo "function cch { java -jar `"$fullPath`" @args }" >> $PROFILE
87+
. $PROFILE
88+
```
89+
90+
#### 手动设置方法
91+
92+
**查找JAR文件路径：**
6693
```bash
67-
# 在Gradle缓存中查找JAR文件路径
68-
find ~/.gradle/caches -name "commitchronicle-0.1.0.jar" -type f
94+
# macOS/Linux
95+
find ~/.gradle/caches -name "*commit-chronicle*" -type f | grep "\.jar$"
6996

70-
# 设置别名（示例 - 需要修改为实际路径）
71-
alias cch="java -jar ~/.gradle/caches/modules-2/files-2.1/com.github.hj4645/commit-chronicle/v0.1.0/*/commitchronicle-0.1.0.jar"
97+
# Windows (PowerShell)
98+
Get-ChildItem -Path "$env:USERPROFILE\.gradle\caches" -Recurse -Name "*commit-chronicle*.jar"
99+
```
100+
101+
**设置别名：**
102+
```bash
103+
# macOS/Linux
104+
alias cch="java -jar /实际/jar/文件/路径/commit-chronicle-1.0.0.jar"
72105

73-
# 或使用直接下载的JAR文件
74-
alias cch="java -jar /path/to/commitchronicle-0.1.0.jar"
106+
# Windows (PowerShell)
107+
function cch { java -jar "C:\实际\jar\文件\路径\commit-chronicle-1.0.0.jar" @args }
75108
```
76109
77110
### 2. 初始设置

0 commit comments

Comments
 (0)