lightning-i2p/README.md

84 lines
3.5 KiB
Markdown
Raw Normal View History

2017-03-20 19:58:59 -04:00
# Lightning Browser [![Build Status](https://travis-ci.org/anthonycr/Lightning-Browser.svg?branch=master)](https://travis-ci.org/anthonycr/Lightning-Browser)
#### Speed, Simplicity, Security
![](ic_launcher_small.png)
#### Download
2014-07-18 22:36:20 -04:00
* [Download APK from here](https://github.com/anthonycr/Lightning-Browser/releases)
2015-10-03 16:03:01 -04:00
* [Download from F-Droid](https://f-droid.org/repository/browse/?fdfilter=lightning&fdid=acr.browser.lightning)
* [Download Free from Google Play](https://play.google.com/store/apps/details?id=acr.browser.barebones)
* [Download Paid from Google Play](https://play.google.com/store/apps/details?id=acr.browser.lightning)
2017-03-20 19:58:59 -04:00
#### Master Branch
2015-01-26 13:35:29 -05:00
* [![Build Status](https://travis-ci.org/anthonycr/Lightning-Browser.svg?branch=master)](https://travis-ci.org/anthonycr/Lightning-Browser)
2017-03-20 19:58:59 -04:00
#### Dev Branch
2015-01-26 13:35:29 -05:00
* [![Build Status](https://travis-ci.org/anthonycr/Lightning-Browser.svg?branch=dev)](https://travis-ci.org/anthonycr/Lightning-Browser)
2017-03-20 19:58:59 -04:00
#### Features
* Bookmarks
* History
2014-05-06 10:12:35 -04:00
* Multiple search engines (Google, Bing, Yahoo, StartPage, DuckDuckGo, etc.)
2014-05-06 10:12:35 -04:00
* Incognito mode
2014-05-06 10:12:35 -04:00
* Follows Google design guidelines
2014-05-06 10:12:35 -04:00
* Unique utilization of navigation drawer for tabs
* Google search suggestions
2015-09-07 19:56:33 -04:00
* Orbot Proxy support and I2P support
2014-07-15 07:23:05 -04:00
2017-03-20 19:58:59 -04:00
#### Permissions
2013-07-29 21:19:26 -04:00
* ````INTERNET````: For accessing the web
* ````WRITE_EXTERNAL_STORAGE````: For downloading files from the browser
* ````READ_EXTERNAL_STORAGE````: For downloading files from the browser
* ````ACCESS_FINE_LOCATION````: For sites like Google Maps, it is disabled by default in settings and displays a pop-up asking if a site may use your location when it is enabled
2014-07-15 07:23:05 -04:00
* ````ACCESS_NETWORK_STATE````: Required for the WebView to function by some OEM versions of WebKit
2017-03-20 19:58:59 -04:00
#### The Code
2014-01-21 20:22:04 -05:00
* Please contribute code back if you can. The code isn't perfect.
* Please add translations/translation fixes as you see need
2017-03-20 19:58:59 -04:00
#### Contributing
2015-10-05 20:05:33 -04:00
* [The Trello Board](https://trello.com/b/Gwjx8MC3/lightning-browser)
2015-08-21 16:47:08 -04:00
* Contributions are always welcome
* If you want a feature and can code, feel free to fork and add the change yourself and make a pull request
* PLEASE use the ````dev```` branch when contributing as the ````master```` branch is supposed to be for stable builds. I will not reject your pull request if you make it on master, but it will annoy me and make my life harder.
2015-09-07 19:56:33 -04:00
* Code Style
2015-10-08 20:08:15 -04:00
* Hungarian Notation
* Prefix member variables with 'm'
* Prefix static member variables with 's'
2015-09-07 19:56:33 -04:00
* Use 4 spaces instead of a tab (\t)
2015-08-21 16:47:08 -04:00
2017-03-20 19:58:59 -04:00
#### Setting Up the Project
Due to the inclusion of the netcipher library for Orbot proxy support, importing the project will show you some errors. To fix this, first run the following git command in your project folder (NOTE: You need the git command installed to use this):
2017-03-20 19:58:59 -04:00
```
git submodule update --init --recursive
2017-03-20 19:58:59 -04:00
```
2015-01-01 18:02:43 -05:00
Once you run that command, the IDE should automatically import netcipher and a couple submodules in as separate projects. Than you need to set the netcipher library project as a libary of the browser project however your IDE makes you do that. Once those steps are done, the project should be all set up and ready to go. [Please read this tutorial for more information on git submodules](http://www.vogella.com/tutorials/Git/article.html#submodules)
2017-03-20 19:58:59 -04:00
#### License
```
Copyright 2014 Anthony Restaino
Lightning Browser
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL
was not distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/
2017-03-20 19:58:59 -04:00
```