X-Git-Url: https://git.openstreetmap.org./rails.git/blobdiff_plain/c3d7cfd7ff90879511ff1c8b54a5d280e2e15057..1ca91ecbac4443ac87ccae9f7c264537f03211c5:/README.md diff --git a/README.md b/README.md index 90a9b93ef..b7d2a4f02 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,47 @@ -# "The Rails Port" +# openstreetmap-website -This is The Rails Port, the [Ruby on Rails](http://rubyonrails.org/) -application that powers the [OpenStreetMap](http://www.openstreetmap.org) website and API. -The software is also known as "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 `openstreetmap-website`, the [Ruby on Rails](http://rubyonrails.org/) +application that powers the [OpenStreetMap](https://www.openstreetmap.org) website and API. This repository consists of: -* The web site, including user accounts, diary entries, user-to-user messaging -* The XML-based editing [API](http://wiki.openstreetmap.org/wiki/API_v0.6) -* 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 -* The Browse pages - a web front-end to the OpenStreetMap data +* The web site, including user accounts, diary entries, user-to-user messaging. +* 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 publically-available services to help with development and testing. +uses publicly-available services to help with development and testing. # License -This software is licensed under the [GNU General Public License 2.0](http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt), +This software is licensed under the [GNU General Public License 2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt), 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 -number of dependencies for installation. For full details please see [INSTALL.md](INSTALL.md) +`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 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) -* There is a [rails-dev@openstreetmap.org](http://lists.openstreetmap.org/listinfo/rails-dev) mailing list for development discussion. +* 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. -* There are also weekly meetings of the OpenStreetMap Foundation Engineering Working Group (EWG) on Mondays at 1700 UTC on the #osm-ewg channel. More details on contributing to the code are in the [CONTRIBUTING.md](CONTRIBUTING.md) file. + +# Maintainers + +* Tom Hughes [@tomhughes](https://github.com/tomhughes/) +* Andy Allan [@gravitystorm](https://github.com/gravitystorm/)