Code 4 OSM
A site which brings together resources for those developing software using OSM data, or part of the OSM infrastructure.
This is a really simple bit of Ruby software to pull together documentation from various places and try to arrange and style it into some sort of cohesive and useful site.
Generating the website
To generate the website, you will need Ruby and several Ruby gems installed. I recommend using rbenv to manage your Ruby versions, but this should also work with Ruby installed by your system packages. For example, on Ubuntu:
sudo apt-get install ruby
The gems which the site needs are managed with "bundler", itself a gem. To install these (on Linux, but probably other systems too) you will need to run:
gem install bundler bundle install
Please see the docs for bundler for any platform specific install instructions.
You will also need to create the configuration file
template for this is provided in
example.config.yml which contains
the three items you will need to configure:
tmpdiris the filesystem path where temporary checked-out versions of projects and other files needed during the assembly of the site will be stored. This could be somewhere in
/tmpon a UNIX system.
targetdiris where the site is finally assembled before being published.
publishdiris where the assembled site is copied to for deployment, for example somewhere in
~/public_htmlon a system running Apache or similar web servers.
config.yml has been created, you can just type:
This will perform all the necessary work to build, assemble and
publish the site to the
We encourage documentation to be written and maintained as close as possible to the source code, and within the repository of the original project. Code4OSM imports this documentation, but aims not to duplicate it.