X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/0e78061cdba5cfb3f299f57b7643d2b396ee235b..095f98c75a3adcfa7a660b1da592d49109937cf8:/README.md?ds=sidebyside diff --git a/README.md b/README.md index b96a77671..b7d2a4f02 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,21 @@ -# "The Rails Port" +# openstreetmap-website [![Lint](https://github.com/openstreetmap/openstreetmap-website/workflows/Lint/badge.svg?branch=master&event=push)](https://github.com/openstreetmap/openstreetmap-website/actions?query=workflow%3ALint%20branch%3Amaster%20event%3Apush) [![Tests](https://github.com/openstreetmap/openstreetmap-website/workflows/Tests/badge.svg?branch=master&event=push)](https://github.com/openstreetmap/openstreetmap-website/actions?query=workflow%3ATests%20branch%3Amaster%20event%3Apush) [![Coverage Status](https://coveralls.io/repos/openstreetmap/openstreetmap-website/badge.svg?branch=master)](https://coveralls.io/r/openstreetmap/openstreetmap-website?branch=master) -This is The Rails Port, the [Ruby on Rails](http://rubyonrails.org/) +This is `openstreetmap-website`, the [Ruby on Rails](http://rubyonrails.org/) application that powers the [OpenStreetMap](https://www.openstreetmap.org) website and API. -The software is also known as "openstreetmap-website". This repository consists of: * The web site, including user accounts, diary entries, user-to-user messaging. -* The XML-based editing [API](https://wiki.openstreetmap.org/wiki/API_v0.6). -* The integrated version of the [iD](https://wiki.openstreetmap.org/wiki/ID) editors. +* The XML- and JSON-based editing [API](https://wiki.openstreetmap.org/wiki/API_v0.6). +* The integrated version of the [iD](https://wiki.openstreetmap.org/wiki/ID) editor. * The Browse pages - a web front-end to the OpenStreetMap data. * The GPX uploads, browsing and API. -A fully-functional Rails Port installation depends on other services, including map tile +A fully-functional `openstreetmap-website` installation depends on other services, including map tile servers and geocoding services, that are provided by other software. The default installation uses publicly-available services to help with development and testing. @@ -27,7 +26,7 @@ a copy of which can be found in the [LICENSE](LICENSE) file. # Installation -The Rails Port is a Ruby on Rails application that uses PostgreSQL as its database, and has a large +`openstreetmap-website` is a Ruby on Rails application that uses PostgreSQL as its database, and has a large number of dependencies for installation. For full details please see [INSTALL.md](INSTALL.md). # Development @@ -35,8 +34,8 @@ number of dependencies for installation. For full details please see [INSTALL.md We're always keen to have more developers! Pull requests are very welcome. * Bugs are recorded in the [issue tracker](https://github.com/openstreetmap/openstreetmap-website/issues). -* 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. * Translation is managed by [Translatewiki](https://translatewiki.net/wiki/Translating:OpenStreetMap). +* Local Chapters shown on the Communities page, and their translations, come from [osm-community-index](https://github.com/osmlab/osm-community-index). * There is a [rails-dev@openstreetmap.org](https://lists.openstreetmap.org/listinfo/rails-dev) mailing list for development discussion. * IRC - there is the #osm-dev channel on irc.oftc.net.