The basis for Heb12 apps written in Go
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Josias 9d88d537e9 Add greater good affirmation 1 year ago
bible bible: fix ListLanguages comment 1 year ago
bibles_test/en Add full asv.xml for testing 1 year ago
bver Fix comment 1 year ago
cmd Work with new bref 1 year ago
config Improve Go code 1 year ago
manage manage: fix GetLanguage errors 1 year ago
osis 2 minor code quality fixes 1 year ago
.gitignore Add basic .gitignore 1 year ago
COPYING Fix COPYING 1 year ago
COPYING.LESSER Add basic info and bver 1 year ago
Makefile Add Makefile 1 year ago
README.md Add greater good affirmation 1 year ago
go.mod Update dependencies 1 year ago
go.sum Update dependencies 1 year ago

README.md

Heb12 Go

https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg Latest Release GoDoc Go Report Card

Note: The official repository is hosted on Heb12’s Gitea instance, but is also mirrored to GitHub.

This program is the basic code which all Heb12 software can include as a library. It is meant to easily centralize all of the code that is shared between the programs. That way each program can use this as a library, but have the platform specific code stored separately.

These new tools are written in Go. This is done because Go is fast, simple, enforces good documentation, and has good support throughout different platforms. It can be used as the foundation for the desktop app, the mobile apps, the website back end, and (with WebAssembly) even the website front end if so desired.

Some code is stored in other repositories. This is because those modules may specifically be useful for other programs, and it makes sense to maintain them separately. bref is an example of this.

Note: This software is in its early stages and is subject to have breaking changes. Do not depend on it for anything important yet.

TODO

Packages

This heb12 module includes several packages which have different uses.

bible

bible uses the modules bref, heb12/manage, heb12/config, and heb12/osis to get Bible verse.

More documentation

bver

A Bible version parser. Useful for parsing human input when it comes to translations, but it does not include all possible Bible versions, and it is not meant to do so. This should not be used in most situations.

More documentation

cmd

A basic CLI for Heb12. It (will) include features to use the rest of the heb12 module, and for reading the Bible from the command line.

config

Config is made for Heb12-specific configuration for using the other packages.

More documentation

manage

A manager for OSIS works in a directory. It provides information about them and manages the directory structure.

More documetation

osis

An OSIS parser. It provides functions to parse OSIS Bible files, and give information about them and the Bible text itself.

More documentation

Search provides functions to generate and read word indexes for the Bible for searching it.

More documentation

License

Copyright (C) 2020 Josias Allestad justjosias@tutanota.com and other Heb12 contributors

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See COPYING.LESSER for more license information.