Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.66 KB

README.md

File metadata and controls

36 lines (22 loc) · 1.66 KB

BoltOSS

Bolt is an offline documentation browser inspired by Dash, dedicatedly built for iOS and iPadOS.

This repository hosts the open-source code that Bolt builds upon.

Releases

This project is in the early development process and the official release will be available soon on AppStore.

As with the consent from Kapeli, to be able to download Dash docsets, you should get Bolt from AppStore when it's available. For platforms other than iOS and iPadOS, check out Dash or Zeal or Velocity instead.

Releases would be tagged or branched but no binary products would be uploaded.

Build instructions

We support building for up to 2 recent major versions of iOS and iPadOS and the most recent major version of Mac Catalyst, so currently it would be built with iOS 16, iPasOS 16, and Mac Catalyst 17 (macOS 14).

Mac Catalyst builds are only for easier development and testing, so only major issues would be solved.

Only the latest non-beta release of Xcode would be supported. Build with the latest Xcode 16 if you encounter any issues.

To checkout and build, use the following commands:

mkdir Bolt
git clone [email protected]:BoltDocs/BoltOSS.git Bolt
cd Bolt
git submodule update --init --recursive
sh developer-setup.sh
open Bolt.xcodeproj

License

This software is licensed under the terms of the Apache License Version 2.0 (Apache-2.0). Full text of the license is available in the LICENSE file and online.