drawio/README.md

45 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

2020-04-09 21:46:06 +00:00
[![Build Status](https://travis-ci.com/jgraph/drawio.svg?branch=master)](https://travis-ci.com/jgraph/drawio)
2017-04-05 15:54:41 +00:00
2016-09-06 14:17:38 +00:00
About
-----
2020-04-09 21:46:06 +00:00
[diagrams.net](https://app.diagrams.net), [previously draw.io](https://www.diagrams.net/blog/move-diagrams-net), is an online diagramming web site that delivers the source in this project.
2016-09-06 13:25:47 +00:00
2016-09-06 14:17:38 +00:00
License
-------
2020-11-11 07:21:29 +00:00
The source code in this repo is licensed under the Apache v2.
2016-09-06 14:05:36 +00:00
2016-09-07 08:54:47 +00:00
Development
-----------
2020-04-09 21:46:06 +00:00
A development guide is being started on the GitHub project wiki. There is a [draw.io](http://stackoverflow.com/questions/tagged/draw.io) tag on Stack Overflow currently, please make sure any questions adhere to their guidelines for questions.
2016-09-07 08:54:47 +00:00
2016-09-07 08:56:07 +00:00
The [mxGraph documentation](https://jgraph.github.io/mxgraph/) provides a lot of the docs for the bottom part of the stack. There is an [mxgraph tag on SO](http://stackoverflow.com/questions/tagged/mxgraph).
2016-09-07 08:54:47 +00:00
2016-09-06 14:17:38 +00:00
Running
-------
2020-04-09 21:46:06 +00:00
One way to run diagrams.net is to fork this project, [publish the master branch to GitHub pages](https://help.github.com/categories/github-pages-basics/) and the [pages sites](https://jgraph.github.io/drawio/src/main/webapp/index.html) will have the full editor functionality (sans the integrations).
2018-08-02 05:22:49 +00:00
2020-06-28 07:06:12 +00:00
Another way is to use [the recommended Docker project](https://github.com/jgraph/docker-drawio) or to download [draw.io Desktop](https://get.diagrams.net).
2019-11-19 15:52:34 +00:00
2017-04-03 15:05:44 +00:00
The full packaged .war of the client and servlets is built when the project is tagged and available on the [releases page](https://github.com/jgraph/draw.io/releases).
2016-09-06 14:17:38 +00:00
Supported Browsers
------------------
2021-01-29 14:59:22 +00:00
diagrams.net supports IE 11, Chrome 70+, Firefox 70+, Safari 11+, Opera 50+, Native Android browser 7x+, the default browser in the current and previous major iOS versions (e.g. 11.2.x and 10.3.x) and Edge 79+.
Open-source, not open-contribution
----------------------------------
[Similar to SQLite](https://www.sqlite.org/copyright.html), diagrams.net is open
source but closed to contributions.
The level of complexity of this project means that even simple changes
can break a _lot_ of other moving parts. The amount of testing required
is far more than it first seems. If we were to receive a PR, we'd have
to basically throw it away and write it how we want it to be implemented.
We are grateful for community involvement, bug reports, & feature requests. We do
not wish to come off as anything but welcoming, however, we've
made the decision to keep this project closed to contributions for
the long term viability of the project.