Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #47

Merged
merged 1 commit into from
Jan 14, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
58 changes: 52 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,58 @@
Gaphor - The UML and SysML(soon!) Modeling Tool
Gaphor
===============================================
The UML modeling tool.

Gaphor is a free/libre/open source UML modeling tool, written in Python and licensed under the LGPLv2.
Prerequisites
~~~~~~~~~~~~~

Install gaphor simply using pip:
Current minimum requirements
^^^^^^^^^^^^^^^^^^^^

$ pip install gaphor
* Currently PyGTK is required for Windows, macOS, and Linux.

For documentation refer to our project website:

http://gaphor.readthedocs.io
Future minimum requirements
^^^^^^^^^^^^^^^^^^^^

* Gaphor will soon require **Python 3**. Legacy Python 2 will no longer be supported.

* If you're on macOS, you will soon need to be on 10.7 (Lion) or newer.

* If you're on Linux, you will soon need to have GTK+ 3.10 or later. This is the version
that ships starting with Ubuntu 14.04 and Fedora 20. You will also soon need to install
the Python 3 bindings to GTK+.

* We're working on Windows support


Quickstart
~~~~~~~~~~

To install, run the following::

$ pip install gaphor


Documentation
~~~~~~~~~~~~~

Documentation for Gaphor can be found on `Read The Docs`_.

Community
~~~~~~~~~

You can talk to the community through:

* The `gaphor`_ channel on Gitter.

Contributing
~~~~~~~~~~~~

If you experience problems with Gaphor, `log them on GitHub`_. If you
want to contribute code, please `fork the code`_ and `submit a pull request`_.

.. _Read The Docs: https://gaphor.readthedocs.io
.. _gaphor: https://gitter.im/gaphor/Lobby
.. _log them on Github: https://github.com/gaphor/gaphor/issues
.. _fork the code: https://github.com/gaphor/gaphor
.. _submit a pull request: https://github.com/gaphor/gaphor/pulls