Getting Started

Assumptions

Since this is the developers wiki, and you are downloading a bleeding edge version of ShortHike, it is assumed that you have an idea on what you are doing. :)

Pre-Requisites

In order to easily compile your own copy of ShortHike, you will need the following installed on your computer:

  • A Subversion client
  • Cygwin
    • Just a basic install will suffice. The only files needed really are:
      • c:\cygwin\bin\find.exe
      • c:\cygwin\bin\grep.exe
      • c:\cygwin\bin\head.exe
      • c:\cygwin\bin\cut.exe
      • c:\cygwin\bin\date.exe (rename this file cyg_date.exe as it will conflict with window's date.exe command)
      • c:\cygwin\bin\bash.exe

Download Source

To download the Shorthike source, you need to checkout the latest files from the repository. If you are using TortoiseSVN simpy right click where you want the source files to be download and select SVN Checkout. Then add http://shorthike.com/svn/trunk as the repository URL.

Warning: the reposity size is approx 70MB, so don't attempt it on a dialup link :)

Not only is the source downloaded, but all the tools you require to compile it as well (such as the D compiler, jam tools, etc).

Environment Setup

Assuming you have downloaded the SVN source into a directory called C:\ShortHike you need to add the following to your system PATH environment variable

  • C:\ShortHike\tools_win32
  • C:\ShortHike\tools_win32\dm\bin
  • C:\ShortHike\tools_win32\dmd\bin

Of course, if you've installed your SVN source elsewhere, then you'll have to change that too.

You may also have to add in cygwin's bin directory in your PATH (if its not there already)

  • C:\Cygwin\bin

Compiling

Open up a command window (Start|Run|cmd.exe). Change directory to your newly downloaded source code. (eg. cd c:\ShortHike)

Now run the command jam debug-ShortHike and it should compile your file into the debug-ShortHike\ directory

NB. Until the repository is fixed up, there is a bug where BuildInfo.d isn't automatically generated using debug-ShortHike as a target. A quick work around is to run jam release-ShortHike. This will at least create a BuildInfo.d file. You can then run your jam debug-ShortHike to compile.

Running

Here is the moment of truth. :)

To run your newly compiled ShortHike program, remain in the c:\ShortHike directory and type in debug-ShortHike\ShortHike.exe

Make sure you are still in the c:\ShortHike directory, otherwise the program won't be able to find it's datafiles.

Troubleshooting?

If you are having trouble with compiling ShortHike, then ask one of us on IRC. One of us is usually around on irc.freenode.org in the #shorthike channel. :)

Enjoy.

LuckyPhil.