From 32edbf5154942a81aed52b91c7ea2dbf935b4144 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Toni=20Scho=CC=88nbuchner?= Date: Wed, 25 Jul 2018 15:17:16 +0200 Subject: [PATCH] changed readme to rst with extension and changed setup.py --- README.rst | 184 +++++++++++++++++++++++++++++++++++++++++++++++++++++ readme.md | 152 ------------------------------------------- setup.py | 2 +- 3 files changed, 185 insertions(+), 153 deletions(-) create mode 100644 README.rst delete mode 100755 readme.md diff --git a/README.rst b/README.rst new file mode 100644 index 00000000000..4b993755f92 --- /dev/null +++ b/README.rst @@ -0,0 +1,184 @@ +.. raw:: html + +
+ GPL badge
GeoNode Logo
A powerful yet easy to use web-based application and platform for deploying spatial data infrastructures (SDI).
+ + + +Table of Contents +---------------- + +- `What is GeoNode? <#what-is-geonode>`__ +- `Try out GeoNode <#try-out-geonode>`__ +- `Install <#install>`__ +- `Learn GeoNode <#learn-geonode>`__ +- `Development <#development>`__ +- `Contributing <#contributing>`__ +- `Roadmap <#roadmap>`__ +- `Showcase <#showcase>`__ +- `Most useful links <#most-useful-links>`__ +- `Licensing <#licensing>`__ + +What is GeoNode? +---------------- + +GeoNode is a geospatial content management system, a platform for the +management and publication of geospatial data. It brings together mature +and stable open-source software projects under a consistent and +easy-to-use interface allowing non-specialized users to share data and +create interactive maps. + +Data management tools built into GeoNode allow for integrated creation +of data, metadata, and map visualization. Each dataset in the system can +be shared publicly or restricted to allow access to only specific users. +Social features like user profiles and commenting and rating systems +allow for the development of communities around each platform to +facilitate the use, management, and quality control of the data the +GeoNode instance contains. + +It is also designed to be a flexible platform that software developers +can extend, modify or integrate against to meet requirements in their +own applications. + +Try out GeoNode +--------------- + +If you just want to try out GeoNode visit our official Demo online at: +http://master.demo.geonode.org. After your registration you will be able +to test all basic functionalities like uploading layers, creation of +maps, editing metadata, styles and much more. To get an overview what +GeoNode can do we recommend to have a look at the `Users +Workshop `__. + +Install +------- + + The latest official release is 2.8! + +GeoNode can be setup in different ways, flavors and plattforms. If +you´re planning to do development or install for production please visit +the offical GeoNode installation documentation: + +- `Docker `__ +- `VM Setup with VirtualBox `__ +- `Ubuntu 16.04 `__ +- `CentOS 7 `__ +- `Windows Binary Installer `__ +- `Installation by deb packages `__ + +Learn GeoNode +------------- + +After you´ve finished the setup process make yourself familiar with the +general usage and settings of your GeoNodes instance. - the `User +Training `__ +is going in depth into what we can do. - the `Administrators +Workshop `__ +will guide you to the most important parts regarding management commands +and configuration settings. + +Development +----------- + +.. raw:: html + + + +GeoNode is a web based GIS tool, and as such, in order to do development +on GeoNode itself or to integrate it into your own application, you +should be familiar with basic web development concepts as well as with +general GIS concepts. + +For development GeoNode can be run in a 'development environment'. In +contrast to a 'production environment' development differs as it uses +lightweight components to speed up things. + +To get you started have a look at the `Install +instructions <#install>`__ which cover all what is needed to run GeoNode +for development. Further visit the the `Developer +workshop `__ +for a basic overview. + +If you´re planning of customizing your GeoNode instance, or to extend +it´s functionalities it´s not advisable to change core files in any +case. In this case it´s common to use setup a `GeoNode Project +Template `__. + +Contributing +------------ + +GeoNode is an open source project and contributors are needed to keep +this project moving forward. Learn more on how to contribute on our +`Community +Bylaws `__. + +Roadmap +------- + +GeoNode's development roadmap is documented in a series of GeoNode +Improvement Projects (GNIPS). They are documented at GeoNode Wiki: +https://github.com/GeoNode/geonode/wiki/GeoNode-Improvement-Proposals. + +GNIPS are considered to be large undertakings which will add a large +amount of features to the project. As such they are the topic of +community dicussion and guidance. The community discusses these on the +developer mailing list: http://lists.osgeo.org/pipermail/geonode-devel/ + +Showcase +-------- + +A handful of other Open Source projects extend GeoNode’s functionality +by tapping into the re-usability of Django applications. Visit our +gallery to see how the community uses GeoNode: `GeoNode +Showcase `__. + +The development community is very supportive of new projects and +contributes ideas and guidance for newcomers. + +Most useful links +----------------- + + +**General** + +- Project homepage: https://geonode.org +- Repository: https://github.com/GeoNode/geonode +- Offical Demo: http://master.demo.geonode.org +- GeoNode Wiki: https://github.com/GeoNode/geonode/wiki +- Issue tracker: https://github.com/GeoNode/geonode-project/issues + + In case of sensitive bugs like security vulnerabilities, please + contact a GeoNode Core Developer directly instead of using issue + tracker. We value your effort to improve the security and privacy of + this project! + +**Related projects** + +- GeoNode Project: https://github.com/GeoNode/geonode-project +- GeoNode at Docker: https://hub.docker.com/u/geonode +- GeoNode OSGeo-Live: https://live.osgeo.org/en/ + + +**Support** + +- User Mailing List: https://lists.osgeo.org/cgi-bin/mailman/listinfo/geonode-users +- Developer Mailing List: https://lists.osgeo.org/cgi-bin/mailman/listinfo/geonode-devel +- Gitter Chat: https://gitter.im/GeoNode/general + + +Licensing +--------- + +GeoNode is Copyright 2018 Open Source Geospatial Foundation (OSGeo). + +GeoNode is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation, either version 3 of the License, or (at your +option) any later version. GeoNode is distributed in the hope that it +will be useful, but WITHOUT ANY WARRANTY; without even the implied +warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along +with GeoNode. If not, see http://www.gnu.org/licenses. diff --git a/readme.md b/readme.md deleted file mode 100755 index d17f1dfce31..00000000000 --- a/readme.md +++ /dev/null @@ -1,152 +0,0 @@ -
- GPL badge -
-GeoNode Logo -
A powerful yet easy to use web-based application and platform for deploying spatial data infrastructures (SDI).
- -# Table of Contents -- [What is GeoNode?](#what-is-geonode) -- [Try out GeoNode](#try-out-geonode) -- [Install](#install) -- [Learn GeoNode](#learn-geonode) -- [Development](#development) -- [Contributing](#contributing) -- [Roadmap](#roadmap) -- [Showcase](#showcase) -- [Most useful links](#most-useful-links) -- [Licensing](#licensing) - -## What is GeoNode? -GeoNode is a geospatial content management system, a platform for the management and publication of geospatial data. It brings together mature and stable open-source software projects under a consistent and easy-to-use interface allowing non-specialized users to share data and create interactive maps. - -Data management tools built into GeoNode allow for integrated creation of data, metadata, and map visualization. Each dataset in the system can be shared publicly or restricted to allow access to only specific users. Social features like user profiles and commenting and rating systems allow for the development of communities around each platform to facilitate the use, management, and quality control of the data the GeoNode instance contains. - -It is also designed to be a flexible platform that software developers can extend, modify or integrate against to meet requirements in their own applications. - -## Try out GeoNode -If you just want to try out GeoNode visit our official Demo online at: http://master.demo.geonode.org. After your registration you will be able to test all basic functionalities like uploading layers, creation of maps, editing metadata, styles and much more. To get an overview what GeoNode can do we recommend to have a look at the [Users Workshop](http://docs.geonode.org/en/master/tutorials/users/index.html). - -## Install -> The latest official release is 2.8! - -GeoNode can be setup in different ways, flavors and plattforms. If you´re planning to do development or install for production please visit -the offical GeoNode installation documentation: -- [Docker](http://docs.geonode.org/en/master/tutorials/install_and_admin/running_docker/index.html) -- [VM Setup with VirtualBox](http://docs.geonode.org/en/master/tutorials/install_and_admin/vm_setup_virtualbox.html) -- [Ubuntu 16.04](http://docs.geonode.org/en/master/tutorials/install_and_admin/geonode_install/index.html) -- [CentOS 7](http://docs.geonode.org/en/master/tutorials/install_and_admin/setup_on_centos/index.html) -- [Windows Binary Installer](http://docs.geonode.org/en/master/tutorials/install_and_admin/win_bin_install/win_binary_installer.html) -- [Installation by deb packages](http://geonode.org) - -## Learn GeoNode - -After you´ve finished the setup process make yourself familiar with the general usage and settings of your GeoNodes instance. -- the [User Training](http://docs.geonode.org/en/master/tutorials/users/index.html) is going in depth into what we can do. -- the [Administrators Workshop](http://docs.geonode.org/en/master/tutorials/admin/index.html) will guide you to the most important parts regarding management commands and configuration settings. - -## Development - - - -GeoNode is a web based GIS tool, and as such, in order to do development on GeoNode itself or to integrate it into your own application, you should be familiar with basic web development concepts as well as with general GIS concepts. - -For development GeoNode can be run in a 'development environment'. In contrast to a 'production environment' development differs as it uses lightweight components to speed up things. - -To get you started have a look at the [Install instructions](#install) which cover all what is needed to run GeoNode for development. Further visit the the [Developer workshop](http://docs.geonode.org/en/master/tutorials/devel/index.html) for a basic overview. - -If you´re planning of customizing your GeoNode instance, or to extend it´s functionalities it´s not advisable to change core files in any case. In this case it´s common to use setup a [GeoNode Project Template](https://github.com/GeoNode/geonode-project). - - -## Contributing - -GeoNode is an open source project and contributors are needed to keep this project moving forward. Learn more on how to contribute on our [Community Bylaws](https://github.com/GeoNode/geonode/wiki/Community-Bylaws). - -## Roadmap - -GeoNode's development roadmap is documented in a series of GeoNode Improvement Projects (GNIPS). They are documented at GeoNode Wiki: https://github.com/GeoNode/geonode/wiki/GeoNode-Improvement-Proposals. - -GNIPS are considered to be large undertakings which will add a large amount of features to the project. As such they are the topic of community dicussion and guidance. The community discusses these on the developer mailing list: http://lists.osgeo.org/pipermail/geonode-devel/ - -## Showcase - -A handful of other Open Source projects extend GeoNode’s functionality by tapping into the re-usability of Django applications. Visit our gallery to see how the community uses GeoNode: [GeoNode Showcase](http://geonode.org/gallery/). - -The development community is very supportive of new projects and contributes ideas and guidance for newcomers. - -## Most useful links - - - - - - - - - - - - - - - - - - - - - - - - - - -
General
Project homepagehttps://geonode.org
Repositoryhttps://github.com/GeoNode/geonode
Offical Demohttp://master.demo.geonode.org
GeoNode Wikihttps://github.com/GeoNode/geonode/wiki
Issue tracker *https://github.com/GeoNode/geonode-project/issues
- - - - - - - - - - - - - - - - -
Related projects
GeoNode Projecthttps://github.com/GeoNode/geonode-project
GeoNode at Dockerhttps://hub.docker.com/u/geonode
GeoNode OSGeo-Livehttps://live.osgeo.org/en/
- - - - - - - - - - - - - - - - - -
Support
User Mailing Listhttps://lists.osgeo.org/cgi-bin/mailman/listinfo/geonode-users
Developer Mailing Listhttps://lists.osgeo.org/cgi-bin/mailman/listinfo/geonode-devel
Gitter Chathttps://gitter.im/GeoNode/general
- -> In case of sensitive bugs like security vulnerabilities, please contact a GeoNode Core Developer directly instead of using issue tracker. We value your effort to improve the security and privacy of this project! - - -## Licensing - -GeoNode is Copyright 2018 Open Source Geospatial Foundation (OSGeo). - -GeoNode is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. -GeoNode is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along with GeoNode. If not, see http://www.gnu.org/licenses. diff --git a/setup.py b/setup.py index 6527f74d112..72292ff5da0 100644 --- a/setup.py +++ b/setup.py @@ -37,7 +37,7 @@ setup(name='GeoNode', version=__import__('geonode').get_version(), description="Application for serving and sharing geospatial data", - long_description=open('README').read(), + long_description=open('README.rst').read(), classifiers=[ "Development Status :: 4 - Beta"], keywords='',