Kod -- a programmers' editor for OS X
A modern and open universal text editor for programmers on Mac OS X.
If you want to use Kod, simply download the latest "stable" version from http://kodapp.com/download/
- General info: http://kodapp.com/
- Discussion forum: http://groups.google.com/group/kod-app
- Support (bugs): http://kodapp.com/support/
- Mainline source code: https://github.com/rsms/kod
- Twitter: @kod_app
- IRC: irc://irc.freenode.net/#kod
- Developer documentation: https://github.com/rsms/kod/wiki
- Daily development builds: http://kod.sivel.net/daily/
Get the source (for building):
git clone --recursive https://github.com/rsms/kod.git git remote add upstream https://github.com/rsms/kod.git
Get the source (for contributing):
If you want to contribute to the project you will have to make a fork. Then do this:
git clone --recursive email@example.com:MyUsername/kod.git git remote add upstream https://github.com/rsms/kod.git
Checkout and build libcss:
This step isn't entirely necessary, but the first time you run this it will check out a bunch of subversion repositories which might take a few minutes.
Refreshing your clone
Since Kod is made up of a main repository as well as a few sub-repositories (git submodules) a simple
git pull is not sufficient to update your source tree clone. Use the
update.sh shell script for this:
It will fetch updates from the upstream repository (rsms/kod). Then you should merge the branches you want to use, for example something like so:
git merge upstream/master
You can use it to update from your own repository by calling it like this:
We prefer that you send a pull request here on GitHub which will then be merged into the official main line repository. You need to sign the Kod CLA to be able to contribute (see below).
Also, in your first contribution, add yourself to the end of
AUTHORS.md (which of course is optional).
Creating and submitting a patch
As mentioned earlier in this article, we prefer that you send a pull request on GitHub.
Clone of your repository:
git clone https://firstname.lastname@example.org/yourusername/kod.git
This is important: Create a so-called topic branch:
git checkout -tb name-of-my-patchwhere "name-of-my-patch" is a short but descriptive name of the patch you're about to create. Don't worry about the perfect name though -- you can change this name at any time later on.
Hack! Make your changes, additions, etc and commit them.
Send a pull request to the upstream repository's owner by visiting your repository's site at github (i.e. https://github.com/yourusername/kod) and press the "Pull Request" button. Here's a good guide on pull requests: http://help.github.com/pull-requests/
Use one topic branch per feature -- don't mix different kinds of patches in the same branch. Instead, merge them all together into your master branch (or develop everything in your master and then cherry-pick-and-merge into the different topic branches). Git provides for an extremely flexible workflow, which in many ways causes more confusion than it helps you when new to collaborative software development. The guides provided by GitHub at http://help.github.com/ are a really good starting point and reference.
If you are fixing a ticket, a convenient way to name the branch is to use the URL slug from the bug tracker, like this:
git checkout -tb 53-feature-manually-select-language.
Contributor License Agreement
Before we can accept any contributions to Kod, you need to sign this CLA:
The purpose of this agreement is to clearly define the terms under which intellectual property has been contributed to Kod and thereby allow us to defend the project should there be a legal dispute regarding the software at some future time.
See the file