readme.md 1.68 KB
Newer Older
Aral Balkan's avatar
Aral Balkan committed
1
# Better for iOS and macOS
2 3 4 5 6 7 8

Better protects you from unethical web sites. It makes your web experience safer, lighter, and faster.

Better enforces the [Ethical Design Manifesto](https://ind.ie/ethical-design). It helps the Web respect human rights, effort, and experience.

Better is curated by Ind.ie, a social enterprise that defends human rights. It’s free, open, and transparent.

Aral Balkan's avatar
Aral Balkan committed
9
## I’m not a developer, I just want to experience a Better web.
10 11 12

Get Better from the App Store.

13 14
## How can I support Better?

Aral Balkan's avatar
Aral Balkan committed
15
Buying Better on the App Store is one way to support us. If you want to help with the ongoing costs of developing and maintaining Better, you can [donate to Ind.ie](https://ind.ie/fund/) or, even better, [become a patron](https://ind.ie/fund/) by setting up a recurring donation.
16

17 18 19 20 21 22 23 24 25 26
## I’m a developer, let me in!

### Installation

On a Mac with Xcode and Git installed:

1. `mkdir better && cd better`
2. `git clone https://source.ind.ie/better/app.git`
3. `cd app && ./install`

Aral Balkan's avatar
Aral Balkan committed
27
That will install all the necessary dependencies.
28 29 30

Specifically, it will install [Better Builder](https://source.ind.ie/better/builder), set up a fully offline local development environment for you, and install the framework dependencies of the iOS app.

31 32
Note: The master branch of Better is now written in Swift 4 and support iOS 11. For the older, Swift 3, version, please see the Swift 3 branch (depracated).

33
### Usage
34

Aral Balkan's avatar
Aral Balkan committed
35 36 37
```bash
./dev
```
38 39 40 41 42 43

This will start the Better Builder environment and open up the Xcode Workspace for the iOS app.

You can then build for the iPhone Simulator and test locally.

See the [Better Builder](https://source.ind.ie/better/builder) project for more information on the development process.