diff --git a/MANIFEST.in b/MANIFEST.in index 417e7eb1f..a3d768a7a 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,5 @@ include README.txt +include README.pypi.rst include ez_setup.py include LICENSE include ga4gh/templates/*.html diff --git a/README.pypi.rst b/README.pypi.rst new file mode 100644 index 000000000..455f1062f --- /dev/null +++ b/README.pypi.rst @@ -0,0 +1,23 @@ + +.. image:: http://genomicsandhealth.org/files/logo_ga.png + +============================== +GA4GH Reference Implementation +============================== + +This is the GA4GH reference implementation. + +Full documentation is available at `read-the-docs.org +`_. + +- For a quick start with the GA4GH API, please see our + `demo `_. +- To configure and deploy the GA4GH server in production + please see the + `installation + `_ + page. +- If you would like to contribute to the project, please see the + `development + `_ + page. diff --git a/README.txt b/README.txt index 8d35da27e..f7d5c190b 100644 --- a/README.txt +++ b/README.txt @@ -9,24 +9,26 @@ GA4GH Reference Implementation :alt: Join the chat at https://gitter.im/ga4gh/server :target: https://gitter.im/ga4gh/server?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge -This is an early alpha of the GA4GH reference client -and server applications. -It is under heavy development, and many aspects of +This is the development version of the GA4GH reference implementation. +If you would like to install the stable version of the server, please +see the instructions on `the PyPI page `_. + +The server is currently under heavy development, and many aspects of the layout and APIs will change as requirements are better understood. If you would like to help, please check out our list of `issues `_! -Full documentation is available at `read-the-docs.org -`_. +The latest bleeding-edge documentation is available at `read-the-docs.org +`_. - For a quick start with the GA4GH API, please see our - `demo `_. + `demo `_. - To configure and deploy the GA4GH server in production please see the `installation - `_ + `_ page. - If you would like to contribute to the project, please see the `development - `_ + `_ page. diff --git a/setup.py b/setup.py index 1a9be5319..f41d01179 100644 --- a/setup.py +++ b/setup.py @@ -25,7 +25,7 @@ def parseVersion(moduleFile): match = re.findall("__version__ = '([^']+)'", s) return match[0] -f = open("README.txt") +f = open("README.pypi.rst") ga4ghReadme = f.read() f.close() ga4ghVersion = parseVersion("ga4gh/__init__.py")