Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aeyoll/nihongo-rs
https://github.com/aeyoll/nihongo-rs
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aeyoll/nihongo-rs
- Owner: aeyoll
- License: mit
- Created: 2024-08-04T16:17:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-31T13:58:57.000Z (4 months ago)
- Last Synced: 2024-10-11T00:45:41.991Z (2 months ago)
- Language: Rust
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Japanese-French Vocabulary
A command-line tool for learning Japanese words with French translations.
## Description
This Rust program helps users learn Japanese vocabulary by allowing them to add Japanese words with their French translations and take quizzes to test their knowledge. It uses a JSON file to store the vocabulary and provides two main functionalities:
1. Adding new words to the vocabulary list
2. Taking a quiz based on the stored words
## Features
- Add Japanese words with their French translations
- Store vocabulary in a JSON file
- Take a 10-question quiz with randomly selected words
- Immediate feedback on quiz answers
- Score tracking for quizzes
## Requirements
- Rust programming language (https://www.rust-lang.org/)
- Cargo package manager (comes with Rust)
## Installation
### From crates.io
```sh
cargo install nihongo
```
### From source
1. Clone this repository:
```sh
git clone https://github.com/yourusername/japanese-french-vocabulary.git
cd japanese-french-vocabulary
```
2. Build the project:
```sh
cargo build --release
```
## Usage
### Adding a word
To add a new word to your vocabulary list:
Example:
```sh
nihongo add
```
### Taking a quiz
To start a 10-question quiz:
```sh
nihongo quiz
```
Specify the number of questions with the `-c` or `--count` option:
```sh
nihongo quiz -c 15
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.