README.md

Komodo Edit

This readme explains how to get started building, using and developing with
the Komodo Edit source base.

Whilst the main Komodo Edit source is hosted under this repository you may also
want to check out the individual component/addon repositories under
https://github.com/Komodo in case you only want to contribute to a specific
component. This'll save you some time and hassle as you would not have to build
the entire project.

Once the build has completed you can simply run Komodo by executing bk run

Upon making any modifications to the source you will again have to run bk build,
or simply bk build && bk run to quickly get back into Komodo. Subsequent builds
should be a lot faster as much of the compiled data is cached.

Once the build has completed you can simply run Komodo by executing bk run

Upon making any modifications to the source you will again have to run bk build,
or simply bk build && bk run to quickly get back into Komodo. Subsequent builds
should be a lot faster as much of the compiled data is cached.

Building with Docker

The easiest way to get started is to use our Docker image, this will basically
provide you with a Ubuntu 12.04 based build of Komodo.

After cloning the repository simply navigate into {repo}/util/docker and check
out ./docklet --help

To use the docker image you need to of course have Docker installed as well as
have X11 forwarding enabled in your SSH client (should work by default on most
linux distros).

Prepare Docker Image

Build the docker image: ./docklet build

Start your container: ./docklet start

SSH into your container to start working: ./docklet ssh

Your project files will be mounted at /komodo/dev

NOTE - if you are updating from a previous version where your project files were
at /root/komodo you will need to fix permissions on your Komodo project and
profile folders. Ie:

Building Steps

Once your image is prepared you can follow the building steps for linux as
described below.

Building Complications

If any errors occur during your first built-time and it is not obvious how to fix
the issue on your own please refer to the Feedback section on how to get in contact
with us.

Note that if building complications arise after you updated your repo with the latest
changes you might need to clear your local cache as it might be conflicting with the
new changes, to do this run bk distclean before running your build steps.