Browse Source

Merge pull request #541 from anthonycr/readme-formatting

Fix formatting of readme
master
Anthony Restaino 8 years ago committed by GitHub
parent
commit
f00e2d4f9b
  1. 37
      README.md

37
README.md

@ -1,7 +1,9 @@
#Lightning Browser [![Build Status](https://travis-ci.org/anthonycr/Lightning-Browser.svg?branch=master)](https://travis-ci.org/anthonycr/Lightning-Browser) # 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) #### Speed, Simplicity, Security
####Download ![](ic_launcher_small.png)
#### Download
* [Download APK from here](https://github.com/anthonycr/Lightning-Browser/releases) * [Download APK from here](https://github.com/anthonycr/Lightning-Browser/releases)
* [Download from F-Droid](https://f-droid.org/repository/browse/?fdfilter=lightning&fdid=acr.browser.lightning) * [Download from F-Droid](https://f-droid.org/repository/browse/?fdfilter=lightning&fdid=acr.browser.lightning)
@ -10,13 +12,13 @@
* [Download Paid from Google Play](https://play.google.com/store/apps/details?id=acr.browser.lightning) * [Download Paid from Google Play](https://play.google.com/store/apps/details?id=acr.browser.lightning)
####Master Branch #### Master Branch
* [![Build Status](https://travis-ci.org/anthonycr/Lightning-Browser.svg?branch=master)](https://travis-ci.org/anthonycr/Lightning-Browser) * [![Build Status](https://travis-ci.org/anthonycr/Lightning-Browser.svg?branch=master)](https://travis-ci.org/anthonycr/Lightning-Browser)
####Dev Branch #### Dev Branch
* [![Build Status](https://travis-ci.org/anthonycr/Lightning-Browser.svg?branch=dev)](https://travis-ci.org/anthonycr/Lightning-Browser) * [![Build Status](https://travis-ci.org/anthonycr/Lightning-Browser.svg?branch=dev)](https://travis-ci.org/anthonycr/Lightning-Browser)
####Features #### Features
* Bookmarks * Bookmarks
* History * History
@ -33,7 +35,7 @@
* Orbot Proxy support and I2P support * Orbot Proxy support and I2P support
####Permissions #### Permissions
* ````INTERNET````: For accessing the web * ````INTERNET````: For accessing the web
@ -45,11 +47,11 @@
* ````ACCESS_NETWORK_STATE````: Required for the WebView to function by some OEM versions of WebKit * ````ACCESS_NETWORK_STATE````: Required for the WebView to function by some OEM versions of WebKit
####The Code #### The Code
* Please contribute code back if you can. The code isn't perfect. * Please contribute code back if you can. The code isn't perfect.
* Please add translations/translation fixes as you see need * Please add translations/translation fixes as you see need
####Contributing #### Contributing
* [The Trello Board](https://trello.com/b/Gwjx8MC3/lightning-browser) * [The Trello Board](https://trello.com/b/Gwjx8MC3/lightning-browser)
* Contributions are always welcome * 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 * If you want a feature and can code, feel free to fork and add the change yourself and make a pull request
@ -60,15 +62,15 @@
* Prefix static member variables with 's' * Prefix static member variables with 's'
* Use 4 spaces instead of a tab (\t) * Use 4 spaces instead of a tab (\t)
####Setting Up the Project #### 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): 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):
```` ```
git submodule update --init --recursive git submodule update --init --recursive
```` ```
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) 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)
####License #### License
```` ```
Copyright 2014 Anthony Restaino Copyright 2014 Anthony Restaino
Lightning Browser Lightning Browser
@ -78,7 +80,4 @@ Lightning Browser
was not distributed with this file, You can obtain one at was not distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/ http://mozilla.org/MPL/2.0/
```` ```
This means that you MUST provide attribution in your application to Lightning Browser for the use of this code. The way you can do this is to provide a separate screen in settings showing what open-source libraries and/or apps (this one) you used in your application. You must also open-source any files that you use from this repository and if you use any code at all from this repository, the file you put it in must be open-sourced according the the MPL 2.0 license. To put it simply, if you create a fork of this browser, your browser must be open-source, no exceptions. The only way to avoid open-sourcing a file is to completely write all the code yourself and to not use any code from Lightning. This is in order to provide a way for companies to utilize the code without making private server code public. For further explanation, please email me, or seek legal counsel :-P
If you have any questions regarding the open-source license, please contact me at [anthonyrestaino11@gmail.com](mailto:anthonyrestaino11@gmail.com)

Loading…
Cancel
Save