https://github.com/mufeedali/wordbook
Wordbook is a dictionary application built for GNOME.
https://github.com/mufeedali/wordbook
dictionary espeak-ng gtk4 libadwaita python wordnet
Last synced: 17 days ago
JSON representation
Wordbook is a dictionary application built for GNOME.
- Host: GitHub
- URL: https://github.com/mufeedali/wordbook
- Owner: mufeedali
- License: gpl-3.0
- Created: 2019-12-14T20:24:48.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T16:34:26.000Z (about 2 years ago)
- Last Synced: 2024-02-12T17:47:08.726Z (about 2 years ago)
- Topics: dictionary, espeak-ng, gtk4, libadwaita, python, wordnet
- Language: Python
- Homepage:
- Size: 4.8 MB
- Stars: 84
- Watchers: 6
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
Wordbook
Look up definitions for words
Wordbook is an offline English-English dictionary application built for GNOME using the Open English WordNet database for definitions and the reliable eSpeak for pronunciations (both audio and phoneme).
## Features
* Fully offline
* Definitions
* Examples
* Word Relations (synonyms, antonyms, etc)
* Pronunciations
* Random Word
* Live Search
* Double click to search
* Support for GNOME Dark Mode and launching app in dark mode.
## Requirements
* GTK 4.16+ [Arch: `gtk4`]
* libadwaita 1.7.0+ [Arch: `libadwaita`]
* Python 3.12+ [Arch: `python`]
* Python modules:
* RapidFuzz [Arch: `python-rapidfuzz`]
* Pydantic [Arch: `python-pydantic`]
* Python GObject [Arch: `python-gobject`]
* ONLY if using Python versions older than 3.14, backports.zstd [Arch: `python-backports-zstd`]
* eSpeak-ng (For pronunciations and audio) [Arch: `espeak-ng`]
## Installation
### Using Flatpak
### Using Nix
[](https://search.nixos.org/packages?size=1&show=wordbook)
This method can be used anywhere the Nix package manager is installed.
### Using distro-specific packages
Wordbook is packaged for Arch through the AUR as [`wordbook`](https://aur.archlinux.org/packages/wordbook).
On NixOS, Wordbook can be installed using the Nix package manager as shown above. Additionally, the following code can be added to your NixOS configuration file, usually located in `/etc/nixos/configuration.nix`.
```
environment.systemPackages = [
pkgs.wordbook
];
```
## Building from Source
To build Wordbook from source, use Meson:
```bash
meson setup builddir
meson compile -C builddir
meson install -C builddir
```
## Contributing
Contributions are welcome. There are many ways to contribute:
1. Open GitHub issues to report bugs or for feature requests.
2. Develop a feature or a bug fix. It would be best to open an issue or discussion first before developing a feature.
3. Add new translations or improve existing translations.
### Development
The best way to work with Wordbook is to either use [GNOME Builder](https://apps.gnome.org/Builder/) or to use [flatplay](https://github.com/mufeedali/flatplay) with your editor of choice.
### Translations
The easiest way to contribute to translations right now is to do one of the following:
1. Approve the LLM-generated translations by removing the line that says `# llm-generated`.
2. Replace the LLM-generated translations.
3. Improve the human-translated strings.
The LLM-generated translations are to try and ease the burden on translators. The idea is to have temporary translations until a human can review them. All strings translated by LLMs are tagged as `llm-generated`.
## Code of Conduct
This project adheres to the [GNOME Code of Conduct](https://conduct.gnome.org/). By participating through any means, including PRs, Issues or Discussions, you are expected to uphold this code.