Add README

This commit is contained in:
Leonora Tindall 2024-08-27 16:20:58 -05:00
parent c47b2a6adf
commit 2c93925f02
2 changed files with 14 additions and 0 deletions

14
README.md Normal file
View File

@ -0,0 +1,14 @@
Sefaria `fortune` Generator
---
This repository provides a Python 3 module called `sefaria_fortune_gen` that
pulls text from the top-ranked Hebrew and English sources in Sefaria for a given
text and creates a basic `fortune` database from them, verse by verse.
## Usage
![Example of the tool being run in a terminal](data/screenshot.png)
This repo uses `uv`, so you can invoke the tool as
`uv run python -m sefaria_fortune_gen <first section title>`.

BIN
data/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB