Skip to content

Commit

Permalink
Add dollar to terminal commands
Browse files Browse the repository at this point in the history
  • Loading branch information
DQNEO committed Sep 9, 2024
1 parent bc015b2 commit 3d58619
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Currently only "New Oxford American Dictionary" is supported.
# Installation

```
go install github.com/DQNEO/apple-dictionary-parser@latest
$ go install github.com/DQNEO/apple-dictionary-parser@latest
```

The command line tool `apple-dictionary-parser ` will be installed in your `$GOPATH/bin` directory.
Expand All @@ -18,7 +18,7 @@ The command line tool `apple-dictionary-parser ` will be installed in your `$GOP
## Export dictionary contents in raw format

```
apple-dictionary-parser dump
$ apple-dictionary-parser dump
```

This `dump` subcommand automatically finds the location of the dictionary file in your MacOS, and extract the binary content into a raw dump file (`/tmp/noad.cache`).
Expand All @@ -33,18 +33,18 @@ If you are just interested in the raw contents of the dictionary and want to pro

## Export dictionary contents into a text file
```
apple-dictionary-parser text > /tmp/all-words.txt
$ apple-dictionary-parser text > /tmp/all-words.txt
```

## Export dictionary contents into a HTML file
```
apple-dictionary-parser html > /tmp/all-words.html
$ apple-dictionary-parser html > /tmp/all-words.html
```

## Export dictionary contents into alphabetically separated HTML files

```
apple-dictionary-parser html-split --out-dir /tmp/
$ apple-dictionary-parser html-split --out-dir /tmp/
```

This generates a.html, b.html, ..., z.html files in a given directory.
Expand All @@ -54,25 +54,25 @@ This generates a.html, b.html, ..., z.html files in a given directory.
If you want to filter words to extract, you can use filtering options such as `--words` or `--words-file`

```
apple-dictionary-parser text --words=--words=happiness,joy,pleasure > /tmp/selected-words.txt
$ apple-dictionary-parser text --words=--words=happiness,joy,pleasure > /tmp/selected-words.txt
apple-dictionary-parser text --words-file=your-words.txt > /tmp/selected-words.txt
$ apple-dictionary-parser text --words-file=your-words.txt > /tmp/selected-words.txt
```

These filtering options are applicable to `text`, `html` and `html-split` subcommands.

## Analyze etymology data

```
apple-dictionary-parser etym /tmp/
$ apple-dictionary-parser etym /tmp/
```

This analyzes etymology graph and make outputs in various formats (yaml, html)

## Show phonetics information

```
apple-dictionary-parser phonetics
$ apple-dictionary-parser phonetics
```

# License
Expand Down

0 comments on commit 3d58619

Please sign in to comment.