Skip to content

Commit

Permalink
Merge pull request #7 from antonyho/dev
Browse files Browse the repository at this point in the history
Adding more information to the README
  • Loading branch information
antonyho authored Nov 10, 2023
2 parents 9198891 + 0ac9c70 commit 44ca3e8
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,71 @@ import (



### Build the binary

#### On Linux
##### Only building the binary
```
make
```

##### Build the binary and generate the database file
```
make generate
```



### Use as executable process
```
./cangjie [cangjie_radicals]
Usage of ./cangjie:
-d string
Custom database file path (default "cangjie.db")
-database string
Custom database file path (default "cangjie.db")
-e Use 'Easy' input method
-easy
Use 'Easy' input method
-h Print usages
-help
Print usages
-p Predict the possible typing word
-prediction
Predict the possible typing word
-s Output simplified Chinese word
-simplified
Output simplified Chinese word
-v int
Cangjie version(3/5) (default 5)
-version int
Cangjie version(3/5) (default 5)
```

#### Usage Example #1
```
❯ ./cangjie hqi
[我 牫 𥫻]
```

#### Usage Example #2
```
❯ ./cangjie -v=5 ykmhm
[產]
```

#### Usage Example #3
```
❯ ./cangjie -v=3 yhhqm
[產 産]
```

#### Usage Example #4
```
❯ ./cangjie -s oiar
[仓]
```


### To-Do Plan
Expand Down

0 comments on commit 44ca3e8

Please sign in to comment.