-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dc86f59
commit ad714e8
Showing
3 changed files
with
28 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,29 +9,35 @@ we adhere to the `Code of Conduct`_ by the Python Software Foundation. | |
|
||
The following steps will help you get started: | ||
|
||
Fork, then clone the repo::: | ||
Fork, then clone the repo: | ||
|
||
git clone [email protected]:your-username/ripe-atlas-tools.git | ||
.. code:: bash | ||
Make sure the tests pass beforehand::: | ||
$ git clone [email protected]:your-username/ripe-atlas-tools.git | ||
tox | ||
Make sure the tests pass beforehand: | ||
|
||
.. code:: bash | ||
$ tox | ||
or | ||
|
||
:: | ||
.. code:: bash | ||
$ nosetests tests/ | ||
nosetests tests/ | ||
Make your changes. Include tests for your change. Make the tests pass: | ||
|
||
Make your changes. Include tests for your change. Make the tests pass::: | ||
.. code:: bash | ||
tox | ||
$ tox | ||
or | ||
|
||
:: | ||
.. code:: bash | ||
nosetests tests/ | ||
$ nosetests tests/ | ||
Push to your fork and `submit a pull request`_. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
.. include:: ../CONTRIBUTING.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,28 @@ | ||
.. RIPE Atlas Tools (Magellan) documentation master file, created by | ||
sphinx-quickstart on Mon Oct 26 18:36:52 2015. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
RIPE Atlas Tools (Magellan) | ||
=========================== | ||
|
||
The official command-line client for RIPE Atlas. | ||
|
||
.. _index-why-this-exists: | ||
|
||
|
||
Why This Exists | ||
=============== | ||
|
||
[RIPE Atlas](https://atlas.ripe.net) is a powerful Internet measurements platform | ||
that until recently was only accessible via the website and the RESTful API. | ||
The reality however is that a great many people using RIPE Atlas are most comfortable | ||
on the command-line, so this project is an attempt to fill that gap. | ||
[RIPE Atlas](https://atlas.ripe.net) is a powerful Internet measurements | ||
platform that until recently was only accessible via the website and the RESTful | ||
API. The reality however is that a great many people using RIPE Atlas are most | ||
comfortable on the command-line, so this project is an attempt to fill that gap. | ||
|
||
|
||
Contents: | ||
Contents | ||
======== | ||
|
||
.. toctree:: | ||
:maxdepth: 3 | ||
:maxdepth: 2 | ||
|
||
installation | ||
quickstart | ||
installation | ||
use | ||
contributing | ||
troubleshooting |