aporia

A Nim IDE.


Keywords
app, binary, ide, gtk, gtk2, nim
License
GPL-2.0
Install
nimble install aporia

Documentation

Aporia

Aporia is an IDE for the Nim programming language. Aporia uses GTK as the default toolkit, and the gtksourceview for the text editor component.

Aporia on Windows 7

Aporia on Mac OS X

Installing

The method by which Aporia can be installed depends on your platform. The following installation instructions are valid as of version 0.4.1 of Aporia.

Windows

The easiest way to install Aporia on Windows is to use one of the Nim windows installers available at the following URL: http://nim-lang.org/download.html#binaries

These installers give you the option to install the latest version of Aporia.

You can also install Aporia via the Nimble package manager, take a look at the Linux/BSD installation instructions to see how this can be done. Keep in mind that you will need to also install Aporia's dependencies manually if you install Aporia this way. The dependencies are listed below under the #dependencies section.

Mac OS X

As of version 0.4.0 Aporia now offers very good Mac OS X support. The releases page contains a zipped archive to an Aporia app bundle, which you can download and begin using immediately!

For your convenience, here is the app bundle for Aporia v0.4.0: https://github.com/nim-lang/Aporia/releases/download/v0.4.0/Aporia_0.4.0_MacOSX.zip

Linux/BSD

Some Linux/BSD distributions may package Aporia so make sure to search for it using your favourite package manager. For example, AUR offers an aporia-git package.

In most cases, you will need to compile and install Aporia manually. The easiest way to do so is using Nimble. First, if you haven't already done so, install Nimble. The instructions for doing so can be found here.

Once Nimble is installed, you can install Aporia by executing the following in a terminal:

nimble install aporia

This will download the latest Aporia release, compile it and install it to ~/.nimble/pkgs/ and ~/.nimble/bin/aporia. You can then execute Aporia by executing ~/.nimble/bin/aporia from your terminal. You can add ~/.nimble/bin to your $PATH to make the execution easier.

If Aporia fails to start with an error similar to the following:

could not load: libgtk2.so

Then you will need to use your Linux/BSD distribution's package manager to install Aporia's dependencies. These include gtk2, gtksourceview (version 2, not 3), and pcre. More information about these can be found in the #dependencies section.

Compiling

To compile Aporia you need the latest version of the nim compiler, preferably the unstable release from github. Aporia sometimes relies on bug fixes which have not yet made it to a stable release.

To build Aporia execute nimble build in its directory. To build and install Aporia execute nimble install in its directory.

You can also quickly install it using nimble without the need to clone this repo yourself, just execute nimble install aporia@#head.

Note: You also need to install some dependencies for Aporia to run. The section below explains this in more detail.

Assuming that all dependencies are installed and you installed Nimble properly, you will be able to launch Aporia by executing aporia in the terminal.

Compiling from C sources

If you do not want to get the nim compiler you can still compile Aporia from the generated C sources, it's as simple as executing the build.sh script (or build.bat on Windows). You can then also use install.sh to install Aporia.

Dependencies

Aporia depends on the following libraries. You may already have those installed especially if you are on Linux.

  • GTK (version 2!)
  • GtkSourceView (any version compatible with GTK2)
  • PCRE

Windows

Warning: If you are on a 64bit version of Windows you must not compile Aporia using a 64 bit version of Nim. This is because there are no 64 bit GTK+ binaries available, see discussion here.

GTK+

If you already have GTK+ on your system, you don't need to do anything. Just make sure GTK+ is in your PATH.

If you don't have GTK+ installed then you need to install it. You can get the latest version from here. Make sure that the installer adds GTK+ to the PATH.

GtkSourceView

The GtkSourceView doesn't have an installer, however binaries are available from here (these are 32 bit only!). Just pick the latest version and download the archive then copy the files/folders in the archive into the 'bin' directory in gtk's directory (Most likely: C:\Program Files\GTK2-Runtime\bin).

libxml2-2

GtkSourceView depends on libxml2-2. This should be downloaded from here (these are 32 bit only!). And the contents of it should be copied the same 'bin' directory as GtkSourceView above. The zip you are looking for is usually called libxml2_2.X.X-1_win32.zip

pcre

The dll for this can be found in nim's repo, in the "dist" directory. Just copy it into aporia's directory or somewhere into your PATH.

Microsoft Visual C++ 2010 Redistributable Package (optional)

If you are experiencing a MSVC100.dll cannot be found then you may need to install the Microsoft Visual C++ 2010 Redistributable Package, this can be downloaded from here (win64)

Linux

Use your package manager to install the dependencies (gtk2, gtksourceview and PCRE).

Mac OS X

The easiest way to get Aporia running on Mac OS X is by installing its dependencies using Homebrew.

$ brew install gtk gtksourceview

To get a nice OS X theme you will also need the GTK Quartz engine. The best one to get is from TingPing/homebrew-gnome.

$ brew tap TingPing/gnome
$ brew install --HEAD gtk-quartz-engine

To use the Quartz engine you must also define the following environment variables.

export GTK_DATA_PREFIX=/usr/local
export GTK_EXE_PREFIX=/usr/local
export GTK2_RC_FILES=$(nimble path aporia | tail -n 1)/share/themes/Quartz/gtk-2.0/gtkrc

You can put those in your .bash_rc file or similar to make it system-wide.

For El Capitan Mac OSX

brew tap homebrew/dupes
brew install libiconv
cd /usr/local/lib/
sudo ln -s libgdk-quartz-2.0.dylib libgdk-x11-2.0.dylib
sudo ln -s libgtk-quartz-2.0.dylib libgtk-x11-2.0.dylib

Note: For this to work you must have Aporia installed via Nimble.

If running aporia now tells you about a missing dynamic library, dependencies might have changed and you could need to brew install another package (tell us this is broken by creating an issue and we will update the documentation).

Assuming that you have set everything up correctly, you should see an Aporia window that looks like this:

Aporia on Mac OS X