jzohrab / lute

DEPRECATED: LUTE (Learning Using Texts) is a self-hosted web app for learning language through reading, based on Learning with Texts (LWT)

DEPRECATED

This version of Lute is obsolete and will no longer be maintained. Instead, please use Lute v3

Lute v3 is a full Python rewrite of Lute. Installation is much easier, and all the features have been ported.

• Install Lute v3
• lute-v3 repository and manual
• If you have Lute v2, you can easily migrate to v3.

Thank you!

---

LUTE - Learning Using Texts

This is a fork and ground-up rewrite of Learning with Texts, for learning foreign languages through reading. You install Lute on your computer, import texts, and annotate terms.

Lute contains the core features you need for learning through reading:

• defining languages and dictionaries
• creating and editing texts
• creating terms and multi-word terms

In addition, Lute has features missing from other tools, which I consider absolutely essential:

• Defining "parent terms". For example, for Spanish, hablar (to speak) is the root form of habló (he spoke). In Lute, you can set a root form as the Parent Term, and the definition for that root form is available for all child terms. Also, when you ask Lute for sample sentences using a term, it includes sentences for all related terms as well. See the wiki for examples.
• Adding word images. This helps learning, and is more interesting and entertaining than adding reams of text.

I have been using Lute for learning Spanish, it's a super tool.

Demo

A very brief demo, showing the core feature: reading a doc, and creating a term:

(fyi - The screenshot was edited for time and file size, so it looks like Lute is automatically filling in the term form -- it's not.)

Lute has other features not shown. See the YouTube introduction video -- it's a bit out-of-date, but gives you an idea -- and check out the Wiki.

Installation

The easiest way to get started with Lute is using Docker. See Running Lute using Docker in the Lute Wiki.

If you can't use Docker, you can also install everything manually, which is how I run Lute myself on my Mac.

Docs

Docs are in the Wiki.

You can also join the Lute Discord Server.

Contribution

If you're a gearhead, like me:

• Read the development notes
• Fork this repo
• Run composer install --dev to install dependencies. If running acceptance tests, run vendor/bin/bdi detect drivers to install Panther drivers
• Make your changes
• Run composer test:full to ensure everything passes. This runs psalm, Doctrine ORM mapping checks, and unit and acceptance tests
• Open a PR to the develop branch

If you're a user: Lute is free :-) ... but if it makes your life better and you feel like saying thanks, I gladly accept coffee. I'll give thanks and will use the caffeine to implement features, or, better, recruit devs to grow the project.

Unlicense

Under unlicense, view UNLICENSE.md, and check out [http://unlicense.org/].

Acknowledgements

Lute would never have existed without the original Learning With Texts and Hugo Fara's fork, so a big thanks to both of these projects.