-
Notifications
You must be signed in to change notification settings - Fork 403
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README markdown to standard pattern * Add screenshot to README.
- Loading branch information
Showing
2 changed files
with
18 additions
and
14 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,32 @@ | ||
[SelfControl](http://selfcontrolapp.com) | ||
=========== | ||
# [SelfControl][website] | ||
|
||
About | ||
----- | ||
SelfControl is a free and open-source application for macOS that lets you block <strong>your own</strong> access to distracting websites, your mail servers, or anything else on the Internet. Just set a period of time to block for, add sites to your blocklist, and click "Start." Until that timer expires, you will be unable to access those sites—even if you restart your computer or delete the application. | ||
<p align="center"> | ||
<img src="./.github/docs/screenshot.png" /> | ||
</p> | ||
|
||
## About | ||
|
||
SelfControl is a free and open-source application for macOS that lets you block **your own** access to distracting websites, your mail servers, or anything else on the Internet. Just set a period of time to block for, add sites to your blocklist, and click "Start Block". Until that timer expires, you will be unable to access those sites—even if you restart your computer or delete the application. | ||
|
||
## Credits | ||
|
||
Credits | ||
------- | ||
Developed by [Charlie Stigler](http://charliestigler.com), [Steve Lambert](http://visitsteve.com), and [others](https://github.com/SelfControlApp/selfcontrol/graphs/contributors). Your contributions very welcome! | ||
|
||
SelfControl is now available in 12 languages thanks to [the fine translators credited here](https://github.com/SelfControlApp/selfcontrol/wiki/Translation-Credits). | ||
|
||
License | ||
------- | ||
SelfControl is free software under the GPL. See [this file](https://github.com/SelfControlApp/selfcontrol/blob/master/COPYING) for more details. | ||
## License | ||
|
||
Building For Development | ||
-------------------- | ||
SelfControl is free software under the GPL. See [this file](./COPYING) for more details. | ||
|
||
Users should always download the latest version of SelfControl from [our website]. If you want to contribute to SelfControl, you'll need to learn to build it for development. This can only be done on a Mac running a modern version of macOS. | ||
## Building For Development | ||
|
||
Users should always download the latest version of SelfControl from [our website][website]. If you want to contribute to SelfControl, you'll need to learn to build it for development. This can only be done on a Mac running a modern version of macOS. | ||
|
||
1. Clone the SelfControl repo from GitHub. | ||
2. Make sure you have a recent version of Xcode and the Xcode command-line tools installed. | ||
3. Install [CocoaPods](https://cocoapods.org/): `sudo gem install cocoapods` | ||
4. Install the SelfControl dependencies using CocoaPods: `pod install` | ||
5. Open the `selfcontrol.xcworkspace` file (NOT `selfcontrol.xcodeproj`) | ||
5. Open the `selfcontrol.xcworkspace` file (**NOT** `selfcontrol.xcodeproj`) | ||
6. Build and run (you may need to update/remove code signing settings to make it build properly) | ||
|
||
[website]: https://selfcontrolapp.com/ |