Commit 8d0dc47f authored by Troy A. Griffitts's avatar Troy A. Griffitts

Extended README to include info about build.phonegap.com

parent 4631b150
To get started...
First, Bishop is built using Cordova, which an HTML / CSS / JavaScript
development platform for multiple devices. Bishop uses SWORD as its
Bible research engine, under the hood, which is C++, and thus a native
iOS and Android SWORD Cordova plugin has been published to the standard
Cordova plugin repository to provide this functionality on both platforms.
First, Bishop is built using Cordova, which is an HTML / CSS / JavaScript
development platform providing cross-platform support for multiple devices.
Bishop uses SWORD as its Bible research engine, under the hood, which is C++,
and thus a native iOS and Android SWORD Cordova plugin has been published to
the standard Cordova plugin repository to provide this functionality on both
dominant mobile platforms.
The HTML / CSS / JavaScript for Bishop can be viewed and updated in a
limited capacity by simply pointing a Web Browser to bishop/www/index.html
......@@ -12,13 +13,26 @@ e.g., using a URL something like:
file:///home/me/src/bishop/www/index.html
Because the native SWORD plugin won't be available though your web browser,
Because the native SWORD plugin won't be available through your web browser,
Bishop provides a mockup of the SWORD plugin to provide 'lorum ipsum' content
to help layout design with working on the HTML / CSS / JavaScript before
compiling for a phone or emulator. This mockup functionality is very basic
and should be extended to include more functionality as needed.
You will find it at the top of www/js/bishop.js: localFixup
Beyond aesthetic changes, a full build of Bishop can be performed with
the information below:
A local development enviroment is ideal and usually requires some form of
bash command line functionality (Linux and macOS, installed by default;
Windows, provided with cygwin (https://www.cygwin.com/) or apparently as a
native install with newer versions of Windows:
https://itsfoss.com/install-bash-on-windows/ )
But if this is not possible, using an online build environment like
build.phonegap.com can provide build facilities
See ## Developing with build.phonegap.com ## later in this README
###### Full Development Setup #########################
......@@ -31,7 +45,8 @@ You will find it at the top of www/js/bishop.js: localFixup
# yum install npm
# npm -g i cordova
#
# but see this link
# but see these links
# https://nodejs.org/en/download/
# https://cordova.apache.org/docs/en/latest/guide/cli/
#
# on iOS we use cordova-icon and cordova-splash to generate
......@@ -50,7 +65,7 @@ Bishop should mostly build with standard cordova commands. For example:
(replace 'ios' with 'android' if compiling for Android)
cordova platform add ios
# There seems to be a bug in recent versions of cordova
# There currently seems to be a bug in recent versions of cordova
# for which the online community gives the workaround to simply remove
# and re-add the platform:
cordova platform rm ios
......@@ -109,6 +124,39 @@ make install
# Product | Archive | Export... | Ad Hoc
########### Development with build.phonegap.com ##############
For scenarios where it is not possible to install a full development
environment, Bishop can still be improved by using an online build
farm service like build.phonegap.com. Instructions follow:
1) Create a free GitHub account for your team. https://github.com
2) Create a new GitHub repository under your new account by importing
our official Bishop repository:
https://github.com/new/import
Our repository URL: http://git.crosswire.org/main/bishop.git
3) Create a free PhoneGap Build account: https://build.phonegap.com/
4) Add a free opensource app to your phonegap build account and provide your
new GitHub repository URL created in step 2. And try out a build. It should
run successfully and produce Bishop binaries for both Android and Apple which
you can download and test on your own device (Android, at least; Apple makes
it a little more difficult to test (understatement))
We likely will continue to add features to Bishop, so you should consider
keeping your GitHub repository updated with our upstream official Bishop
repository to get the latest features. Something like:
git pull upstream master
########## Extending SWORD Cordova plugin ###############################
If, instead of using the released version of the SWORD cordova plugin,
you'd like to build it yourself....
......@@ -142,3 +190,4 @@ cd ~src/sword/bindings/objc
make
Again, thank you for partnering with us to share the Good New of our Lord Jesus Christ with a world desperate for Him.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment