diff --git a/MANIFEST.in b/MANIFEST.in index 79a246e4..b97c7d67 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include README.rst +include README.md include AUTHORS include LICENSE include MANIFEST.in diff --git a/README.md b/README.md new file mode 100644 index 00000000..2c7e327c --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +GNS3-gui +======== + +[![image](https://github.com/GNS3/gns3-gui/workflows/testing/badge.svg)](https://github.com/GNS3/gns3-gui/actions?query=workflow%3Atesting) + +[![image](https://img.shields.io/pypi/v/gns3-gui.svg)](https://pypi.python.org/pypi/gns3-gui) + +[![image](https://snyk.io/test/github/GNS3/gns3-gui/badge.svg)](https://snyk.io/test/github/GNS3/gns3-gui) + +GNS3 GUI repository. + +Installation +------------ + +Please see + +Software dependencies +--------------------- + +PyQt5 which is either part of the Linux distribution or installable from +PyPi. The other Python dependencies are automatically installed during +the GNS3 GUI installation and are listed +[here](https://github.com/GNS3/gns3-gui/blob/master/requirements.txt) + +For connecting to nodes using Telnet, a Telnet client is required. On +Linux that's a terminal emulator like xterm, gnome-terminal, konsole +plus the telnet program. For connecting to nodes with a GUI, a VNC +client is required, optionally a SPICE client can be used for Qemu +nodes. + +For using packet captures within GNS3, Wireshark should be installed. +It's recommended, but if you don't need that functionality you can go +without it. + +Development +----------- + +If you want to update the interface, modify the .ui files using QT +tools. And: + +``` {.bash} +cd scripts +python build_pyqt.py +``` + +### Debug + +If you want to see the full logs in the internal shell you can type: + +``` {.bash} +debug 2 +``` + +Or start the app with --debug flag. + +Due to the fact PyQT intercept you can use a web debugger for inspecting +stuff: + +Security issues +--------------- + +Please contact us at diff --git a/README.rst b/README.rst deleted file mode 100644 index a91f6172..00000000 --- a/README.rst +++ /dev/null @@ -1,60 +0,0 @@ -GNS3-gui -======== - -.. image:: https://github.com/GNS3/gns3-gui/workflows/testing/badge.svg - :target: https://github.com/GNS3/gns3-gui/actions?query=workflow%3Atesting - -.. image:: https://img.shields.io/pypi/v/gns3-gui.svg - :target: https://pypi.python.org/pypi/gns3-gui - -.. image:: https://snyk.io/test/github/GNS3/gns3-gui/badge.svg - :target: https://snyk.io/test/github/GNS3/gns3-gui - - -GNS3 GUI repository. - -Installation ------------- - -Please see https://docs.gns3.com/ - -Software dependencies ---------------------- - -PyQt5 which is either part of the Linux distribution or installable from PyPi. The other Python dependencies are automatically installed during the GNS3 GUI installation and are listed `here `_ - -For connecting to nodes using Telnet, a Telnet client is required. On Linux that's a terminal emulator like xterm, gnome-terminal, konsole plus the telnet program. For connecting to nodes with a GUI, a VNC client is required, optionally a SPICE client can be used for Qemu nodes. - -For using packet captures within GNS3, Wireshark should be installed. It's recommended, but if you don't need that functionality you can go without it. - -Development -------------- - -If you want to update the interface, modify the .ui files using QT tools. And: - -.. code:: bash - - cd scripts - python build_pyqt.py - -Debug -""""" - -If you want to see the full logs in the internal shell you can type: - -.. code:: bash - - debug 2 - - -Or start the app with --debug flag. - -Due to the fact PyQT intercept you can use a web debugger for inspecting stuff: -https://github.com/Kozea/wdb - -Security issues ----------------- - -Please contact us at security@gns3.net - - diff --git a/setup.py b/setup.py index ae2a02b1..26211a8b 100644 --- a/setup.py +++ b/setup.py @@ -66,7 +66,7 @@ setup( author="Jeremy Grossmann", author_email="package-maintainer@gns3.net", description="GNS3 graphical interface for the GNS3 server.", - long_description=open("README.rst", "r").read(), + long_description=open("README.md", "r").read(), install_requires=open("requirements.txt", "r").read().splitlines(), entry_points={ "gui_scripts": [