Important

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

Contributing

Local development

• Clone this repository.
• Install:
  • Go
  • Task
  • Bun
• Run task install to install the project dependencies.
• Run task --list to list the available commands.

Refer to the contributor's guide for more in-depth information.

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. 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
• GNU General Public License version 3.0 (GPLv3)