gns3-registry/README.rst
Julien Duponchelle 2d4732ba07 Custom symbol support (registry part)
Proposal for the symbol support:
* We can specify a symbol in the appliance via the symbol field (gui
will fallback to default symbol if not internet available)
* Contributor should provide the licence for the symbol

Fix #5
2015-10-02 14:52:15 +02:00

54 lines
975 B
ReStructuredText

GNS3-registry
================
.. image:: https://travis-ci.org/GNS3/gns3-registry.svg
:target: https://travis-ci.org/GNS3/gns3-registry
This is the GNS3 registry where user can share
appliances configurations and symbols.
Add a new symbol
################
Look for examples in the symbols directory.
Add a new appliance
###################
Two way to create a new appliance:
* Copy paste a JSON from the appliances directory
* Use the new_appliance.py
After that you can send us a pull request on Github.
In schemas/appliance.json you have a JSON with a schema for controlling the file
and can be use as documentation for each fields.
Tools
#######
All tools require python3 and the installation of dependencies via:
.. code:: bash
pip3 install -r requirements.txt
Check appliance files
-----------------------
.. code:: bash
python3 check.py
Create a new appliance
-----------------------
.. code:: bash
python3 new_appliance.py