Skip to content

Commit d4f1980

Browse files
Add contribution information
1 parent 13875a7 commit d4f1980

4 files changed

Lines changed: 32 additions & 26 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Contributing
2+
------------
3+
4+
Thank you for your interest in contributing to ChatSecure! To avoid potential legal headaches and to allow distribution on Apple's App Store please sign our CLA (Contributors License Agreement). For contributing translations, please check out our [Transifex](https://www.transifex.com/projects/p/chatsecure/) page.
5+
6+
1. Sign the CLA ([odt](https://github.com/chrisballinger/Off-the-Record-iOS/blob/master/media/CLA.odt), [pdf](https://github.com/chrisballinger/Off-the-Record-iOS/blob/master/media/CLA.pdf)) and email it to [chris@chatsecure.org](mailto:chris@chatsecure.org).
7+
2. [Fork](https://github.com/chrisballinger/Off-the-Record-iOS/fork) the project and (preferably) work in a feature branch.
8+
3. Open a [pull request](https://github.com/chrisballinger/off-the-record-ios/pulls) on GitHub.
9+
4. Thank you!

README.md

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
ChatSecure
22
=========
33

4-
ChatSecure is an instant messaging client for iOS that integrates encrypted "Off the Record" messaging support from the [libotr](http://www.cypherpunks.ca/otr/) library. It uses the [LibOrange](https://github.com/unixpickle/LibOrange) library to handle all of the AIM (OSCAR) functionality and the [XMPPFramework](https://github.com/robbiehanson/XMPPFramework/) to handle Jabber/GTalk (XMPP).
4+
ChatSecure is a free and open source instant messaging client for iOS that integrates encrypted [OTR](http://en.wikipedia.org/wiki/Off-the-Record_Messaging) ("Off the Record") messaging support from the [libotr](http://www.cypherpunks.ca/otr/) library. It uses the [LibOrange](https://github.com/unixpickle/LibOrange) library to handle all of the AIM (OSCAR) functionality and the [XMPPFramework](https://github.com/robbiehanson/XMPPFramework/) to handle Jabber/GTalk (XMPP).
55

66

77
Cost
88
=========
99

10-
This project is \***100% free**\* because it is important that all people around the world have unrestricted access to privacy tools.
10+
This project is **100% free** because it is important that all people around the world have unrestricted access to privacy tools.
1111
However, developing and supporting this project is hard work and costs real money. Please help support the development of this project! We now also accept Bitcoin via Coinbase! :)
1212

1313
[![bitcoin](https://coinbase.com/assets/buttons/donation_large-6ec72b1a9eec516944e50a22aca7db35.png)](https://coinbase.com/checkouts/1cf35f00d722205726f50b940786c413) [![donation](https://chatsecure.org/static/images/paypal_donate.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=XRBHJ9AX5VWNA)
@@ -34,32 +34,15 @@ Compatibility
3434
Native
3535
------
3636
* **[Adium](http://adium.im/) (Mac OS X) - OTR works over both XMPP and Oscar.**
37-
* climm (Unix-like), since (mICQ) 0.5.4.
38-
* MCabber (Unix-like), since 0.9.4
39-
* CenterIM (Unix-like), since 4.22.2
40-
* Phoenix Viewer (successor of Emerald Viewer), a Second Life client (Cross-platform)
41-
* Vacuum IM (Cross-platform)
4237
* Jitsi (Cross-platform)
43-
* BitlBee (Cross-platform), since 3.0 (optional at compile-time)
4438

4539
Plug-in
4640
------
4741
* [Pidgin](http://pidgin.im/) (cross-platform), with [pidgin-otr](http://www.cypherpunks.ca/otr/index.php#downloads) plugin.
48-
* Kopete (Unix-like), either with a third-party plugin or, since the addition of Kopete-OTR on 12th of March 2008, with the version of Kopete shipped with KDE 4.1.0 and later releases.
49-
* Miranda IM (Microsoft Windows), with a third-party plugin
50-
* Psi (Cross-platform), with a third-party plugin and build, in Psi+ native usable
51-
* Trillian (Microsoft Windows), with a third-party plugin
52-
* irssi, with a third-party plugin
53-
54-
Proxy (download [here](http://www.cypherpunks.ca/otr/index.php#downloads))
55-
------
56-
* AOL Instant Messenger (Mac OS X, Microsoft Windows)
57-
* iChat (Mac OS X)
58-
* Proteus (Mac OS X)
5942

6043
Phone apps
6144
------
62-
* [Gibberbot](https://guardianproject.info/apps/gibber/) (formerly OtRChat), a free and open source Android application (still in early development) produced by The Guardian Project, provides OTR protocol compatible over XMPP chat.
45+
* **[ChatSecure Android](https://guardianproject.info/apps/gibber/) (formerly known as Gibberbot)**, a free and open source Android application produced by The Guardian Project, provides OTR protocol compatible over XMPP chat.
6346
* [BEEM](http://beem-project.com/projects/beem) - Android XMPP client (compatibility unknown)
6447

6548
[Full List](http://en.wikipedia.org/wiki/Off-the-Record_Messaging#Client_support)
@@ -69,8 +52,8 @@ Build Instructions
6952
- Install [mogenerator](http://rentzsch.github.io/mogenerator/) `brew install mogenerator`
7053
- Dowload `git clone git@github.com:chrisballinger/Off-the-Record-iOS.git --recursive`
7154
- `cd Off-the-Record-iOS/`
72-
- Build Facebook framework `./Submodules/facebook-ios-sdk/scripts/build_framework.sh`
73-
- Open `Off the Record.xcodeproj` in Xcode and build
55+
- Create `/Off the Record/OTRSecrets.h` and fill in blank strings for the missing API keys: `USERVOICE_KEY`, `USERVOICE_SECRET`, `GOOGLE_APP_SECRET`, `HOCKEY_LIVE_IDENTIFIER`, and `HOCKEY_BETA_IDENTIFIER`.
56+
- Open `Off the Record.xcodeproj` in Xcode and build.
7457

7558
License
7659
=========
@@ -92,16 +75,27 @@ License
9275
You should have received a copy of the GNU General Public License
9376
along with this program. If not, see <http://www.gnu.org/licenses/>.
9477

95-
If you would like to relicense this code to sell it on the App Store,
78+
If you would like to relicense this code to distribute it on the App Store,
9679
please contact me at [chris@chatsecure.org](mailto:chris@chatsecure.org).
9780

98-
This software additionally references or incorporates the following sources
99-
of intellectual property, the license terms for which are set forth
100-
in the sources themselves:
81+
Contributing
82+
------------
83+
84+
Thank you for your interest in contributing to ChatSecure! To avoid potential legal headaches and to allow distribution on Apple's App Store please sign our CLA (Contributors License Agreement). For contributing translations, please check out our [Transifex](https://www.transifex.com/projects/p/chatsecure/) page.
85+
86+
1. Sign the CLA ([odt](https://github.com/chrisballinger/Off-the-Record-iOS/blob/master/media/CLA.odt), [pdf](https://github.com/chrisballinger/Off-the-Record-iOS/blob/master/media/CLA.pdf)) and email it to [chris@chatsecure.org](mailto:chris@chatsecure.org).
87+
2. [Fork](https://github.com/chrisballinger/Off-the-Record-iOS/fork) the project and (preferably) work in a feature branch.
88+
3. Open a [pull request](https://github.com/chrisballinger/off-the-record-ios/pulls) on GitHub.
89+
4. Thank you!
90+
10191

10292
Third-party Libraries
10393
=========
10494

95+
This software additionally references or incorporates the following sources
96+
of intellectual property, the license terms for which are set forth
97+
in the sources themselves:
98+
10599
The following dependencies are bundled with the ChatSecure, but are under
106100
terms of a separate license:
107101

@@ -124,6 +118,8 @@ terms of a separate license:
124118
Acknowledgements
125119
=========
126120

121+
Thank you to everyone who helped this project become a reality! This project is also supported by the fine folks from [The Guardian Project](https://guardianproject.info) and [OpenITP](https://openitp.org).
122+
127123
* [Nick Hum](http://nickhum.com/) - awesome icon.
128124
* [Glyphish](http://glyphish.com/) - icons used on the tab bar.
129125
* [Adium](http://adium.im/) - lock/unlock icon used in chat window, status gems.
@@ -137,3 +133,4 @@ Acknowledgements
137133
* [vitalyster](https://github.com/vitalyster) (Russian)
138134
* [burhan teoman](https://www.transifex.net/accounts/profile/burhanteoman/) (Turkish)
139135
* [shikibiomernok](https://www.transifex.net/accounts/profile/shikibiomernok/) (Hungarian)
136+
* Many many more!

media/contributing/CLA.odt

17.5 KB
Binary file not shown.

media/contributing/CLA.pdf

74.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)