Improve installation documentation and add contributor instructions
[rails.git] / README.md
1 # "The Rails Port"
2
3 This is The Rails Port, the [Ruby on Rails](http://rubyonrails.org/)
4 application that powers the [OpenStreetMap](http://www.openstreetmap.org) website and API.
5 The software is also known as "openstreetmap-website".
6
7 This repository consists of:
8
9 * The web site, including user accounts, diary entries, user-to-user messaging
10 * The XML-based editing [API](http://wiki.openstreetmap.org/wiki/API_v0.6)
11 * The integrated versions of the [Potlatch](http://wiki.openstreetmap.org/wiki/Potlatch_1), [Potlatch 2](http://wiki.openstreetmap.org/wiki/Potlatch_2) and [iD](http://wiki.openstreetmap.org/wiki/ID) editors
12 * The Browse pages - a web front-end to the OpenStreetMap data
13 * The GPX uploads, browsing and API.
14
15 A fully-functional Rails Port installation depends on other services, including map tile
16 servers and geocoding services, that are provided by other software. The default installation
17 uses publically-available services to help with development and testing.
18
19 # License
20
21 This software is licensed under the [GNU General Public License 2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt),
22 a copy of which can be found in the [LICENSE](LICENSE) file.
23
24 # Installation
25
26 The Rails Port is a Ruby on Rails application that uses PostgreSQL as its database, and has a large
27 number of dependencies for installation. For full details please see [INSTALL.md](INSTALL.md)
28
29 # Development
30
31 We're always keen to have more developers! Pull requests are very welcome.
32
33 * Bugs are recorded in the [issue tracker](https://github.com/openstreetmap/openstreetmap-website/issues).
34 * Some bug reports are also found on the [OpenStreetMap trac](https://trac.openstreetmap.org/) system, in the "[website](https://trac.openstreetmap.org/query?status=new&status=assigned&status=reopened&component=website&order=priority)" and "[api](https://trac.openstreetmap.org/query?status=new&status=assigned&status=reopened&component=api&order=priority)" components
35 * Translation is managed by [Translatewiki](https://translatewiki.net/wiki/Translating:OpenStreetMap)
36 * There is a [rails-dev@openstreetmap.org](http://lists.openstreetmap.org/listinfo/rails-dev) mailing list for development discussion.
37 * IRC - there is the #osm-dev channel on irc.oftc.net.
38 * There are also weekly meetings of the OpenStreetMap Foundation Engineering Working Group (EWG) on Mondays at 1700 UTC on the #osm-ewg channel.
39
40 More details on contributing to the code are in the [CONTRIBUTING.md](CONTRIBUTING.md) file.