Skip to content

Commit

Permalink
Update documentation for Safari
Browse files Browse the repository at this point in the history
Include build instructions
  • Loading branch information
el1t committed Dec 6, 2016
1 parent 5dcee29 commit 2ccad1a
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ Read first: <https://github.com/gorhill/uBlock/blob/master/CONTRIBUTING.md>

[If you fail to provide this info, I will mark the issue as invalid. Lists all settings which differs from default settings]

- Browser/version:
- Safari version:
- uBlock Origin version:
- MacOS version:

##### Your filter lists

Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,12 @@ To help diagnose and fix the bug/issue, please always include the following in y
* A screenshot or transcription of **any of uBlock's preferences that differ from the defaults**
* This includes a whitelisted website, enabled/disabled filter list, anything
* Please do include everything different from the defaults whether or not it seems relevant to your issue
* The version of uBlock you're having the issue with; you can find this in [uBlock's popup UI](https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface)
* Example: `uBlock 0.9.0.0`
* The browser you're using and its version
* Examples: `Firefox 36`, `Chrome 41.0.2272`
* The OS you're using and its version
* Examples: `Windows 8.1`, `Linux Mint 17.1`
* The version of uBlock Origin you're having the issue with; you can find this in [uBlock's popup UI](https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface)
* Example: `uBlock 1.10.0`
* The Safari version you're using
* Examples: `Safari 10.0.1`, `Safari TP 18`
* The MacOS version you're using
* Examples: `MacOS Sierra 10.12.1`, `OSX 10.10.5`
* A list of other extensions you have installed
* Tip: try disabling them and see if your issue still occurs

Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ uBlock Origin<br>
**An efficient blocker add-on for various browsers. Fast, potent, and lean.**

## Regarding this Safari port

The majority of this code is shared with [upstream](https://github.com/gorhill/uBlock). Platform specific portions are under development.
Much of the platform shim from the original uBlock Safari version is still being used.

* [Installation](#installation)
* [Building](#building)
* [Release History](#release-history)
* [Further Documentation](#further-documentation)
* [About](#about)
Expand All @@ -38,11 +40,29 @@ Compatible with Safari 10, untested on older versions.

To benefit from uBlock Origin's higher efficiency, it's advised that you don't use other inefficient blockers at the same time (such as AdBlock or Adblock Plus). uBlock₀ will do [as well or better](#blocking) than most popular ad blockers.

## Building

To build and load an unpacked extension for development:

1. Clone `uBlock-Safari` and [`uAssets`](https://github.com/uBlockOrigin/uAssets) into the same parent directory
1. Run `./tools/make-safari.sh` in `uBlock-Safari`'s directory
1. Install the unpacked extension through Safari's Extension Builder
1. In Safari, load the Extension Builder (Develop > Show Extension Builder)
1. Click the `+` button in the bottom left corner and "Add Extension"
1. Select `dist/build/uBlock.safariextension`
1. Click install and enter your password
1. You will have to reinstall from this panel every time you restart Safari

> If you don't see a Develop menu in Safari, you can run
> `defaults write com.apple.Safari IncludeDevelopMenu -bool true`
> or go to Preferences > Advanced > Show Develop menu in menu bar.
## Release History

See the [releases pages](https://github.com/el1t/uBlock-Safari/releases) for a history of releases and highlights for each release.

## Further Documentation

Visit the upstream [uBlock Origin wiki](https://github.com/gorhill/uBlock/wiki) for further documentation.

## About
Expand Down
2 changes: 1 addition & 1 deletion platform/safari/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<plist version="1.0">
<dict>
<key>Author</key>
<string>Chris Aljoudi</string>
<string>Chris Aljoudi/Raymond Hill</string>
<key>Builder Version</key>
<string>534.57.2</string>
<key>CFBundleDisplayName</key>
Expand Down

0 comments on commit 2ccad1a

Please sign in to comment.