Updated README.md

This commit is contained in:
B.J. Dweck 2023-09-08 11:30:05 +03:00
parent 18a9cb0dd9
commit 51401ba964

View File

@ -1,11 +1,14 @@
# csv2ankicards # csv2ankicards
A simple tool to convert CSV files into Anki deck packages (.apkg files). A simple toolkit that offers:
- Conversion of CSV files into Anki deck packages (.apkg files).
- Conversion of image files in a directory to a text file using Optical Character Recognition (OCR).
## Features ## Features
- Converts a CSV file with questions and answers into an Anki deck package. - Converts a CSV file with questions and answers into an Anki deck package.
- There are only two columns in the CSV file, separated by the first comma encountered. - Converts image files from a specified directory to a single text file using OCR.
- For CSV: there are only two columns in the CSV file, separated by the first comma encountered.
- CSV files should have a "Front" column for questions and a "Back" column for answers. - CSV files should have a "Front" column for questions and a "Back" column for answers.
## Installation ## Installation
@ -29,6 +32,8 @@ A simple tool to convert CSV files into Anki deck packages (.apkg files).
## Usage ## Usage
### CSV to Anki Conversion
To convert a CSV file into an Anki deck package: To convert a CSV file into an Anki deck package:
```bash ```bash
@ -37,19 +42,33 @@ python csv2ankicards.py /path/to/your/csvfile.csv output.apkg
This will produce an `output.apkg` file which can then be imported into Anki. This will produce an `output.apkg` file which can then be imported into Anki.
### CSV Format #### CSV Format
The CSV file should follow this format: The CSV file should follow this format:
``` ```
Front,Back Front,Back
Your question here,Your answer here, and here Your question here,Your answer here
Another question,list of: answer1, answer2, answer3 Another question,list of: answer1, answer2, answer3
... ...
``` ```
**Note:** If your answers contain commas, they will be considered as part of the answer. Only the first comma is used to separate the question from the answer. **Note:** If your answers contain commas, they will be considered as part of the answer. Only the first comma is used to separate the question from the answer.
### Image to Text Conversion
To convert images from a directory to a single text file using OCR:
```bash
python images2text.py /path/to/your/image_directory/
```
This will produce a `final.txt` file which contains the text extracted from the images.
#### Supported Image Formats
Currently supported formats for the images are: `.png`, `.jpg`, and `.jpeg`.
## License ## License
[MIT License](LICENSE) [MIT License](LICENSE)