Skip to content

Commit

Permalink
Merge pull request #53 from NASA-AMMOS/issue-52
Browse files Browse the repository at this point in the history
Issue #52 - Convert README.md to README.rst for PyPi
  • Loading branch information
lorsposto authored May 7, 2018
2 parents 58b336c + 4d33d0c commit 1d1044a
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 28 deletions.
26 changes: 0 additions & 26 deletions README.md

This file was deleted.

41 changes: 41 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
AMMOS Instrument Toolkit (AIT)
==============================

The AMMOS Instrument Toolkit (Formerly the Bespoke Links to Instruments
for Surface and Space (BLISS)) is a Python-based software suite
developed to handle Ground Data System (GDS), Electronic Ground Support
Equipment (EGSE), commanding, telemetry uplink/downlink, and sequencing
for JPL International Space Station and CubeSat Missions. It is a
generalization and expansion of tools developed for a number of JPL ISS
missions.

Getting Started
---------------

You can read through the `Installation and Configuration
Page <http://ait-core.readthedocs.io/en/latest/installation.html>`__ for
instruction on how to install AIT Core.

You can read through the `New Project Setup
Page <http://ait-core.readthedocs.io/en/latest/project_setup.html>`__
for instructions on how to use AIT on your next project.

Contributing
------------

For information on how to contribute please see the `AIT Contributors
Guides <http://ait-core.readthedocs.io/en/latest/contribute.html>`__

--------------

|travis|
|docs|

.. |travis| image:: https://travis-ci.org/NASA-AMMOS/AIT-Core.svg?branch=master
:alt: build status
:scale: 100%
:target: https://travis-ci.org/NASA-AMMOS/AIT-Core
.. |docs| image:: https://readthedocs.org/projects/ait-core/badge/?version=master
:alt: Documentation Status
:scale: 100%
:target: https://ait-core.readthedocs.io/en/latest/?badge=master
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

# Get the long description from the README file
here = path.abspath(path.dirname(__file__))
with io.open(path.join(here, 'README.md'), encoding='utf-8') as f:
with io.open(path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()

class InstallWithGithooks(install):
Expand All @@ -45,7 +45,7 @@ def run(self):
version = '0.37.0',
description = description,
long_description = long_description,
long_description_content_type = 'text/markdown',
long_description_content_type = 'text/x-rst',
url = 'https://github.com/NASA-AMMOS/AIT-Core',
packages = find_packages(exclude=['tests']),
author = 'AMMOS Instrument Toolkit Development Team',
Expand Down

0 comments on commit 1d1044a

Please sign in to comment.