Convert README to rst [ci skip]
This commit is contained in:
Родитель
34a3ce4cc2
Коммит
ac70961307
37
README.md
37
README.md
|
@ -1,37 +0,0 @@
|
|||
Experimental Glue WWT plugin
|
||||
==============================
|
||||
|
||||
[![Build Status](https://travis-ci.org/glue-viz/glue-wwt.svg)](https://travis-ci.org/glue-viz/glue-wwt?branch=master)
|
||||
[![Build status](https://ci.appveyor.com/api/projects/status/8cxo7uvxd8avuj7p/branch/master?svg=true)](https://ci.appveyor.com/project/glue-viz/glue-wwt/branch/master)
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Note that this plugin requires [glue](http://glueviz.org/) to be installed -
|
||||
see [this page](http://glueviz.org/en/latest/installation.html) for
|
||||
instructions on installing glue.
|
||||
|
||||
Installing
|
||||
----------
|
||||
|
||||
To install the latest stable version of the plugin, you can do:
|
||||
|
||||
pip install glue-wwt
|
||||
|
||||
or you can install the latest developer version from the git repository using:
|
||||
|
||||
pip install https://github.com/glue-viz/glue-wwt/archive/master.zip
|
||||
|
||||
This will auto-register the plugin with Glue. Now simply start up Glue, open a
|
||||
tabular dataset, drag it onto the main canvas, then select 'WorldWideTelescope
|
||||
(WWT)'.
|
||||
|
||||
Testing
|
||||
-------
|
||||
|
||||
To run the tests, do:
|
||||
|
||||
py.test glue_wwt
|
||||
|
||||
at the root of the repository. This requires the [pytest](http://pytest.org)
|
||||
module to be installed.
|
|
@ -0,0 +1,49 @@
|
|||
Experimental Glue WWT plugin
|
||||
============================
|
||||
|
||||
|Build Status| |Build status|
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Note that this plugin requires `glue <http://glueviz.org/>`__ to be
|
||||
installed - see `this
|
||||
page <http://glueviz.org/en/latest/installation.html>`__ for
|
||||
instructions on installing glue.
|
||||
|
||||
Installing
|
||||
----------
|
||||
|
||||
To install the latest stable version of the plugin, you can do:
|
||||
|
||||
::
|
||||
|
||||
pip install glue-wwt
|
||||
|
||||
or you can install the latest developer version from the git repository
|
||||
using:
|
||||
|
||||
::
|
||||
|
||||
pip install https://github.com/glue-viz/glue-wwt/archive/master.zip
|
||||
|
||||
This will auto-register the plugin with Glue. Now simply start up Glue,
|
||||
open a tabular dataset, drag it onto the main canvas, then select
|
||||
'WorldWideTelescope (WWT)'.
|
||||
|
||||
Testing
|
||||
-------
|
||||
|
||||
To run the tests, do:
|
||||
|
||||
::
|
||||
|
||||
py.test glue_wwt
|
||||
|
||||
at the root of the repository. This requires the
|
||||
`pytest <http://pytest.org>`__ module to be installed.
|
||||
|
||||
.. |Build Status| image:: https://travis-ci.org/glue-viz/glue-wwt.svg
|
||||
:target: https://travis-ci.org/glue-viz/glue-wwt?branch=master
|
||||
.. |Build status| image:: https://ci.appveyor.com/api/projects/status/8cxo7uvxd8avuj7p/branch/master?svg=true
|
||||
:target: https://ci.appveyor.com/project/glue-viz/glue-wwt/branch/master
|
|
@ -1 +1 @@
|
|||
__version__ = "0.1.dev"
|
||||
__version__ = "0.1.dev0"
|
||||
|
|
10
setup.py
10
setup.py
|
@ -9,16 +9,12 @@ entry_points = """
|
|||
wwt=glue_wwt:setup
|
||||
"""
|
||||
|
||||
try:
|
||||
import pypandoc
|
||||
LONG_DESCRIPTION = pypandoc.convert('README.md', 'rst')
|
||||
except (IOError, ImportError):
|
||||
with open('README.md') as infile:
|
||||
LONG_DESCRIPTION = infile.read()
|
||||
|
||||
with open('glue_wwt/version.py') as infile:
|
||||
exec(infile.read())
|
||||
|
||||
with open('README.rst') as infile:
|
||||
LONG_DESCRIPTION = infile.read()
|
||||
|
||||
install_requires = ['numpy',
|
||||
'glue-core>=0.10',
|
||||
'qtpy',
|
||||
|
|
Загрузка…
Ссылка в новой задаче