https://github.com/ju4n97/lector

https://github.com/ju4n97/lector

a11y bionic-reading docx ebook education epub gplv3 html lector literature markdown pdf productivity reader reading rsvp-reading speed-reading text-to-speech

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ju4n97/lector
• Owner: ju4n97
• License: gpl-3.0
• Created: 2020-05-26T01:55:25.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-14T20:06:12.000Z (7 months ago)
• Last Synced: 2025-03-22T11:46:32.324Z (about 1 month ago)
• Topics: a11y, bionic-reading, docx, ebook, education, epub, gplv3, html, lector, literature, markdown, pdf, productivity, reader, reading, rsvp-reading, speed-reading, text-to-speech
• Language: Go
• Homepage:
• Size: 526 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
> [!IMPORTANT]

> This project is currently in a very early stage of development. As such, features and documentation are subject to change.

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/lector-org/lector/ci.yaml?style=flat&colorA=000000)

## Contributing

    Local development

- Clone this repository.

- Install:

  - [Go](https://go.dev/)

  - [Task](https://taskfile.dev/)

  - [Bun](https://bun.sh/)

- Run `task install` to install the project dependencies.

- Run `task --list` to list the available commands.

Refer to the [contributor's guide](CONTRIBUTING.md) for more in-depth information.

## License

[![image](https://www.gnu.org/graphics/gplv3-with-text-136x68.png)](https://www.gnu.org/licenses/gpl-3.0.html)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Flector-org%2Flector.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Flector-org%2Flector?ref=badge_large&issueType=license)

Lector is primarily licensed under the GNU General Public License v3.0 (GPLv3), except for the `pkg` module, which is licensed under the [MIT license](pkg/LICENSE). This allows the code in `pkg` to be reused in other projects with fewer restrictions, as it is not subject to the copyleft requirements of GPLv3.

### GPLv3 license key requirements

- Must disclose the source code

- Include the license and copyright notice

- Use the same license for derivative works

- Clearly indicate any modifications

### References

- [GPLv3 explained in plain English](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3)

- [GNU General Public License version 3.0 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0.html)