Skip to content

VictorMs/KomodoEdit

 
 

Repository files navigation

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.

Table of Contents

Screenshot

Screenshot

Download

You can download Komodo Edit here, or if you wish to try the more powerful IDE version you can download Komodo IDE here.

Feedback

There are several ways to get in contact with the Komodo devs:

Github: https://github.com/Komodo/KomodoEdit

Forums: http://community.activestate.com/forums/komodo

Bug Tracker: http://bugs.activestate.com/enter_bug.cgi?product=Komodo

IRC: irc://irc.mozilla.org/#komodo

Mailing Lists: komodo-discuss & komodo-beta

Building Komodo

Note that these are simplified steps of the building process, for a more in-depth guide check <BUILD.txt>.

Building on Windows

Prerequisites

See http://developer.mozilla.org/en/docs/Windows_Build_Prerequisites for more details on Windows build prerequisites. However, following the above steps is meant to be sufficient to get Komodo building.

Building Steps

  • Checkout Komodo Edit: git clone https://github.com/Komodo/KomodoEdit.git

  • Using the command line, enter your checkout directory and run:

     cd mozilla
     setenv-moz-msvc11.bat
     python build.py configure -k 9.10
     python build.py distclean all
    

    This will configure and build mozilla and can take anywhere from 30 minutes to several hours to complete (depending on your specs). For most modern machines it should be about an hour.

  • After mozilla is built successfully go back to the main repo directory and build komodo:

     cd ..
     set PATH=util\black;%PATH%
     bk configure -V 9.10.0-devel
     bk build
    

    This should take significantly less time than building Mozilla.

  • 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 on Mac & Linux

Mac Prerequisites

  • Python >=2.7 (but not Python 3.x yet). You can install ActivePython from here.

    If you prefer the Python builds from python.org should be sufficient as well.

  • Xcode. Install the latest one.

  • Xcode Command Line Tools.

    Open the Xcode preferences, then in the Downloads tab, select and install the Command Line Tools.

  • MacPorts. (Note: Fink may work too but most of the build testing and instructions is done with MacPorts.)

  • autoconf v2.13. Once you have MacPorts installed you need just run sudo port install autoconf213

  • ensure you are using clang or gcc 4.2 (or higher)

See http://developer.mozilla.org/en/docs/Mac_OS_X_Build_Prerequisites for more details on Mac OS X build prerequisites. However, following the above steps is meant to be sufficient to get Komodo building.

Linux Prerequisites

Ubuntu

sudo apt-get build-dep firefox

Fedora

sudo yum install gcc-c++ patch gtk2-devel libIDL-devel libcurl-devel

Others

Building Steps

  • Checkout Komodo Edit: git clone https://github.com/Komodo/KomodoEdit.git

  • Using the terminal, enter your checkout directory and run:

     cd komodo/mozilla
     python build.py configure -k 9.10
     python build.py distclean all
    

    This will configure and build mozilla and can take anywhere from 30 minutes to several hours to complete (depending on your specs). For most modern machines it should be about an hour.

  • After mozilla is built successfully go back to the main repo directory and build komodo:

     cd ..
     export PATH=`pwd`/util/black:$PATH   # Komodo's "bk" build tool
     bk configure -V 9.10.0-devel
     bk build
    

    This should take significantly less time than building Mozilla.

  • 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:

chown -R <my-username>:<my-group> <my-project-location>
chown -R <my-username>:<my-group> ~/.komodoide

You will also need to redo your build (distclean mozilla and komodo).

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.

About

Komodo Edit a free, fast and multi-language code editor

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 48.8%
  • JavaScript 17.1%
  • C++ 12.1%
  • C 11.8%
  • Perl 3.6%
  • CSS 1.4%
  • Other 5.2%