Skip to content

Latest commit

 

History

History
78 lines (62 loc) · 4.14 KB

BUILD.md

File metadata and controls

78 lines (62 loc) · 4.14 KB
Raw

Building

We provide you with two ways to compile and install Blink Shell. This instructions will refer to assembling a full Blink Shell, compiling libraries and resources yourself. Due to the many dependencies that compose Blink Shell, this is the recommended but not shortest method. You can also clone Blink and obtain a "ready to go" tar.gz with all the dependencies as described on home

Requirements

Please note that to compile and install Blink in your personal devices, you need to comply with Apple Developer Terms and Conditions, including obtaining a Developer License for that purpose. You will also need all the XCode command line developer tools and SDKs provided under a separate license by Apple Inc.

  • XCode > 7.3 and XCode command line tools
  • Autotools for OSX

Cloning

Clone Blink into your local repository and make sure to obtain any submodules: git submodule init git submodule update

Dependencies & Requirements

Blink makes use of multiple dependencies that you have to compile separately before building Blink itself. There are simple scripts available to perform this operation.

Please note that Blink currently only supports armv64 and x86_64 (simulator) platforms, so compilation for other architectures is not necessary.

Installation

Libraries

The Blink Shell XCode project will look for Library dependencies under the Framework folder. Libssh2 and Mosh for iOS will also build OpenSSL and Protobuf respectively, both required to work.

To install Libssh2 and OpenSSL in your Blink repository, please copy the .framework files generated on Libssh2 for iOS to the Framework folders.

Mosh for iOS will compile both protobuf and Mosh for iOS. After compiling, copy libmoshios.framework AND libprotobuf.a from the build-protobuf/protobuf-version/lib folder.

Blink also makes use of two other projects, which should be automatically downloaded using git submodule within the same project:

  • UICKeyChainStore
  • MBProgressHUD

If you would like to use HockeySDK (not required), download the latest version and drop it Frameworks.

Resources

Blink Shell makes use of a web terminal running from JavaScript code and linked at runtime. All the required resources to bundle the app, like terminal, fonts and themes, must be included under the Resources folder.

Blink Shell makes use of Chromium's HTerm. To bundle it, start by cloning Chromium's libapps, and generate hterm_all.js with the bin/mkdist.sh script (their build instructions are less than clear!). Drop the generated hterm_all.js file into the Resources folder.

Font Style uploads requires webfonts.js, but it isn't needed for Blink to work. Download the file and drop it into Resources folder.

Blink's Terminal is running from JavaScript code linked at runtime. Most of the available open source terminals can be made to work with Blink, just by providing a "write" and "signal" functions. An example of this is provided in the Resources/term.html file. If you use another terminal.js, edit term.html to match. We have been also successful plugging in other terminals like Terminal.js.

Compiling

Blink uses a standard .xcodeproj file. Any missing files will be marked in red, what can be used to test your installation.

To configure the project:

  1. Under Targets > Blink > General > Identities set a unique Bundle Identifier.
  2. Under Targets > Blink > General > Identities set your Team.
  3. You might be requested to accept your profile or setup your developer account with XCode, follow the proper Apple Developer documentation in that case.
  4. If you would like to use HockeyApp, change the scheme to Blink Hockey, and add HockeyID with your AppID string to info.plist.

Make sure "Blink" is the selected Scheme for compilation. As a standard XCode project, just run it with Cmd-R.