Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
1over137 committed Jul 20, 2021
1 parent 4210883 commit 54ba17c
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Simple Sentence Mining (`ssmtool`) is a program for sentence mining, in which se

This program monitors your clipboard at all times and when a change is detected, the contents gets copied onto the "Sentence" field. From there, you can double click any word, and the program will send a query to Wiktionary, and display the result on the "Definition" field, while simultaneously filling in the "word" field for you. You may also double click from words in the "Definition" field to get definition, because Wiktionary sometimes simply lists the base forms of inflected words.

![Demo](demo.gif)
![Demo](https://imgur.com/aF34qax.gif)

## Prerequisites

Expand All @@ -30,29 +30,38 @@ Alternatively, you can also install with pip: `pip install ssmtool`
**Important**: On macOS it is important to have Anki open on the foreground, otherwise the API will respond very slowly, causing lags in the application.

## How to use
0. Configure it by pressing the "Configure.." button at the bottom. (only once)
1. Open any website, ebook, or text document.
2. Select a sentence (or any segment of text)
3. Copy it to clipboard (Ctrl + C)
4. Double click on a word in the "Sentence" field to look it up.
5. If needed, double click on a word in the "Definition" field to look it up.
6. Click on the "Add note" button.
First, you need to configure it by pressing the "Configure.." button at the bottom. You only need to do it once.

### With Click-Copy-Sentence
1. Open any website
2. Click on a word
3. Check if the definition makes sense, if not, double-click on one of the words in the Sentence field.
4. Click on the "Add note" button.

### General use
1. Copy any text to clipboard
2. Click on a word in the Sentence field
3. Check if the definition makes sense. You can also look up any word in the Definition field.
4. Click on the "Add note" button.


## Recommended tools
*Disclaimer: These projects are not affiliated with `ssmtool`*
| Service | Plugin | Note |
*Disclaimer: Except for the companion web extension, these projects are not affiliated with the author of `ssmtool`*
| Service/Application | Plugin | Note |
--------- | ------ | ------
| Netflix | Subadub ([Firefox](https://addons.mozilla.org/en-US/firefox/addon/subadub/), [Chrome](https://chrome.google.com/webstore/detail/subadub/jamiekdimmhnnemaaimmdahnahfmfdfk)) | Chrome extension to make subtitles selectable (also copy-able) |
| Youtube | [youtube-dl](https://github.com/ytdl-org/youtube-dl) | Download videos from youtube (videos can be played locally with subtitles, which are then copy-able with mpv). |
| mpv | [mpvacious](https://github.com/Ajatt-Tools/mpvacious) | Automatically copies subtitles to clipboard (which will show up on this tool) |
| Anki | [AwesomeTTS](https://ankiweb.net/shared/info/814349176) | Automatically generates TTS for cards generated from this tool. You can configure it to produce TTS on demand for the note type used by `ssmtool`, complementing your flashcards.
| Browser | Click Copy Sentence ([Firefox](https://addons.mozilla.org/en-GB/firefox/addon/click-copy-sentence/), Chrome version coming soon.) | Companion browser extension for ssmtool. Enables single-click note creation. |



## Future plans
This program is still at an early stage. More features will be added soon.

Current plans include:
- Audio
- Undo
- Usage statistics
- Other dictionaries
- Auto-selecting the most difficult words
Expand Down

0 comments on commit 54ba17c

Please sign in to comment.