paladin1
/
scriptura
1
0
Fork 0
Code Issues 5 Pull Requests Projects Releases 2 Activity
A ncurses frontend to the SWORD project. (see http://crosswire.org/)
4 Commits 2 Branches 2 Tags 105 KiB
C++ 94.3%
C 4.6%
Makefile 1.1%
Go to file
Paul Mosier 1d51da03bb Fixed make install. 2021-09-19 22:18:09 -04:00
.gitignore Fixed make install. 2021-09-19 22:18:09 -04:00
CODE_OF_CONDUCT.md Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
CONTRIBUTING.md Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
COPYING Initial commit! Testing remote repository access. 2021-09-08 23:28:35 -04:00
Doxyfile Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
LICENSE Initial commit! Testing remote repository access. 2021-09-08 23:28:35 -04:00
Makefile Fixed make install. 2021-09-19 22:18:09 -04:00
README.md Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
free.cpp Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
free.h Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
pane.cpp Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
pane.h Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
scabbard.cpp Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
scabbard.h Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
scriptura.cpp Updating documentation, last bugfixes before first release. 2021-09-18 23:11:10 -04:00
scriptura.ini Initial commit! Testing remote repository access. 2021-09-08 23:28:35 -04:00

README.md

Scriptura

A ncurses-based frontend to the SWORD project, the CrossWire Bible Society's Bible software library.

This program was written to scratch a personal itch. I do a lot of daily computer work in the command line, I wanted something more feature-rich than libsword's diatheke, and I wanted to sharpen my C skills. I imagine there are probably a single-digit's amount of people in the world who are interested in doing their Bible study from a command line terminal. If you happen to be one of them, please feel free to use this program. Its layout and interface are very loosely based on OliveTree, a Bible study app popular on the Android platform.

Dependencies

  • clang
  • libsword and its development libraries (often available in most distributions' standard repos)
  • ncurses and its development libraries (any modern Linux version should work)
  • doxygen (optional, if you're a documentation nerd)

Getting started

To install scriptura (into /usr/local by default):

git clone https://tildegit.org/paladin1/scriptura.git

cd scriptura

make

sudo make install

On first run, scriptura assumes that a King James module is intalled and available. Many modules from CrossWire are available here and other frontends have their own repos. To install them from the command line:

mkdir -p $HOME/.sword/

cd $HOME/.sword/

curl https://www.crosswire.org/ftpmirror/pub/sword/packages/rawzip/KJVA.zip

unzip KJVA.zip

A configuration file will be created at $HOME/.config/scriptura.ini. You can see the sample config file in the codebase for available options.

When the software is running, the '?' key will give you the list of commands available. Open any module you have installed and you can go to or search any text.

Known issues

Menus and forms will not render correctly if your terminal window is too narrow. Resize the terminal and this should work.

Feedback / Support / Gratuity

For patch or code submissions, see the CONTRIBUTING file.

Please use the tildegit project forum page to submit any feature requests or bug reports. For bugs, please include the descriptions of whatever module was used and relevant config/environment settings, and a list of steps to reproduce the problem. Please also adhere to the code of conduct.

Other means of contact can be found here

This project is basically a one-man operation. If you'd like to show your support financially, you can contribute via:

  • Paypal - paladin1 at sdf.org
  • BTC - bc1q9dfau346z38jth35gkaxacd3fljvfgw6cqcyyv

Disclaimer

I'm not a programmer by day. While I have tested this thing and believe it to be beta-worthy, I assume no responsibility if it crashes your computer, ruins your holiday, or kicks your dog.