README
¶
USFM Toolkit
A toolkit to analyze, parse & convert USFM formatted text files.
Visit the wiki for documentation about the usage, architecture etc.,
Development
If you are interested to contribute to this project, please follow the instruction given here.
- Install Go compiler
- Run this command to get source code:
go get github.com/baijum/usfm(Git is a prerequisite)
The code will be available under $GOPATH/src/github.com/baijum/usfm
You will also a get an executable binary under $GOPATH/bin/usfm.
You can fork the project from Github and push your changes there. Later you can send pull request with your changes. Before sending the pull request, make sure the tests are running locally using this command:
go test ./...
I also recommend to run these tools:
- go fmt - format the code as per the Go community standard
- go vet - reports suspicious constructs
- golint - reports more lint issues
Please run these commands before sending pull request. This will help
us to maintain the quality of code. You can run the run.sh shell
script to run all the above mentioned tools including tests.
Credits
The parser is created based on the article written by Ben Johnson
Documentation
¶
There is no documentation for this package.
Source Files
Directories