Skip to content

Commit caa35e2

Browse files
authored
Update README.md
1 parent 6038f47 commit caa35e2

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22
jplookup is a Python tool designed to scrape pitch accent, phonetic pronunciation, definitions and example sentences from Wiktionary and turn them into straight-forward flashcards for Anki.
33
![oniisan](example-outputs/oniisan-sample.png)
44

5+
<br>
6+
7+
# Installation
8+
9+
```pip install jplookup```
10+
11+
<br>
12+
13+
You can also clone the repository and install the required dependencies (`bs4` and `jaconv`) as such:
14+
```bash
15+
git clone https://github.com/travisgk/jplookup.git
16+
cd jplookup
17+
pip install -r requirements.txt
18+
```
19+
20+
<br>
21+
522
# Features
623
## Pitch Accent
724
Anki cards made with jplookup can mark the pitch accent.
@@ -50,18 +67,3 @@ When Wiktionary links to a different page for an alternative spelling, then the
5067
- "撮る" redirects to the Wiktionary page for "とる" and grabs any definitions that are either specified as fitting with "撮る" or definitions with no context/kanji specification at all.
5168
- "取る" redirects to the Wiktionary page for "とる" and grabs any definitions that are either specified as fitting with "取る" or definitions with no context/kanji specification at all.
5269
- "とる" (the hiragana directly) goes to the Wiktionary page for "とる" and grabs all definitions regardless of context specification.
53-
54-
<br>
55-
56-
## Installation
57-
58-
```pip install jplookup```
59-
60-
<br>
61-
62-
You can also clone the repository and install the required dependencies (`bs4` and `jaconv`) as such:
63-
```bash
64-
git clone https://github.com/travisgk/jplookup.git
65-
cd jplookup
66-
pip install -r requirements.txt
67-
```

0 commit comments

Comments
 (0)