Skip to content

Commit 8b29d05

Browse files
magjacmagjac
authored
Merge pull request #23 from magjac/meta-info-updates
Meta info updates
2 parents 1ba7284 + 1b681ba commit 8b29d05

File tree

5 files changed

+121
-3
lines changed

5 files changed

+121
-3
lines changed

‎README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,34 @@ Learn more from the Create React App [README](https://github.com/facebook/create
5656
* Firefox 61.0.1
5757
* Chrome 64.0.3282.167
5858

59-
## Currently Known Limitations ##
59+
## Known Issues ##
6060

61-
Apart from the numerous cool features that are missing; here's a list of known limitations in the features that do exist:
61+
Known issues are **not listed here**.
6262

63-
* The visual editing capabilities requires the DOT source to be organized with only one node or edge per line, since they currently operate by inserting or deleting complete lines.
63+
All known bugs and enhancement requests are reported as issues on [GitHub](https://github.com/magjac/graphviz-visual-editor) and are listed under the [Issues](https://github.com/magjac/graphviz-visual-editor/issues) tab.
64+
65+
### [All open issues](https://github.com/magjac/graphviz-visual-editor/issues) ###
66+
67+
Lists both bugs and enhancement requests.
68+
69+
### [Known open bugs](https://github.com/magjac/graphviz-visual-editor/labels/bug) ###
70+
71+
### [Open enhancement requests](https://github.com/magjac/graphviz-visual-editor/labels/enhancement) ###
72+
73+
### [Known limitations](https://github.com/magjac/graphviz-visual-editor/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Abug+label%3Aenhancement) ###
74+
75+
(A limitation is a feature deliberately released without full functionality. A limitation is classifed both as a bug and as an enhancement request to reflect that although it's a enhancement not yet implemented from the author's perspective, it might be perceived as a bug from user's perspective).
76+
77+
### [Closed issues](https://github.com/magjac/graphviz-visual-editor/issues?q=is%3Aissue+is%3Aclosed) ###
6478

6579
## Roadmap ##
6680

81+
There are numerous cool features missing. They are or will be listed as [enhancement requests](https://github.com/magjac/graphviz-visual-editor/labels/enhancement) on [GitHub](https://github.com/magjac/graphviz-visual-editor).
82+
83+
There is also a [project board](https://github.com/magjac/graphviz-visual-editor/projects/1) showing the short-term activities.
84+
85+
The medium-term plan is:
86+
6787
* Implement some of the nicest-to-have features, learn from that and rework the UI.
6888
* Provide documentation.
6989
* Open up for collaboration.

‎public/index.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
<meta name="viewport" content="user-scalable=0, initial-scale=1, minimum-scale=1, width=device-width, height=device-height">
66
<!-- PWA primary color -->
77
<meta name="theme-color" content="#000000">
8+
<meta name="keywords" content="Web, Application, Interactive, Visual, Editor, Graphviz, Graph, DOT">
9+
<meta name="description" content="A web application for interactive visual editing of Graphviz graphs described in the DOT language">
10+
<meta name="author" content="Magnus Jacobsson">
811
<title>Graphviz Visual Editor</title>
912
</head>
1013
<body>

‎src/AboutDialog.js

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,66 @@ class AboutDialog extends React.Component {
4949
<DialogContentText>
5050
Version {packageJSON.version}
5151
</DialogContentText>
52+
<br/>
53+
<DialogContentText>
54+
The Graphviz Visual Editor is a web application for
55+
interactive visual editing of
56+
{' '}
57+
<a
58+
href="http://www.graphviz.org"
59+
target="_blank"
60+
rel="noreferrer noopener"
61+
>
62+
Graphviz
63+
</a>
64+
{' '}
65+
graphs described in the
66+
{' '}
67+
<a
68+
href="https://www.graphviz.org/doc/info/lang.html"
69+
target="_blank"
70+
rel="noreferrer noopener"
71+
>
72+
DOT
73+
</a>
74+
{' '}
75+
language.
76+
It is <u>not</u> a general drawing application.
77+
It can only generate graphs that are possible to describe with DOT.
78+
</DialogContentText>
79+
<br/>
80+
<DialogContentText>
81+
The Graphviz Visual Editor is an
82+
{' '}
83+
<a
84+
href="https://en.wikipedia.org/wiki/Open-source_software"
85+
target="_blank"
86+
rel="noreferrer noopener"
87+
>
88+
open source
89+
</a>
90+
{' '}
91+
project and is hosted at
92+
{' '}
93+
<a
94+
href="https://github.com/magjac/graphviz-visual-editor"
95+
target="_blank"
96+
rel="noreferrer noopener"
97+
>
98+
GitHub
99+
</a>
100+
. See the
101+
{' '}
102+
<a
103+
href="https://github.com/magjac/graphviz-visual-editor/blob/master/README.md"
104+
target="_blank"
105+
rel="noreferrer noopener"
106+
>
107+
README
108+
</a>
109+
{' '}
110+
for more information.
111+
</DialogContentText>
52112
<DialogContentText variant='caption' className={classes.copyright}>
53113
&copy; 2018 Magnus Jacobsson Interactive AB
54114
</DialogContentText>

‎src/ButtonAppBar.js

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import ZoomOutIcon from '@material-ui/icons/ZoomOut';
1212
import ZoomOutMapIcon from '@material-ui/icons/ZoomOutMap';
1313
import SettingsIcon from '@material-ui/icons/Settings';
1414
import HelpIcon from '@material-ui/icons/Help';
15+
import GitHubIcon from './GitHubIcon'
1516

1617
const styles = {
1718
root: {
@@ -24,6 +25,12 @@ const styles = {
2425
marginLeft: -12,
2526
marginRight: 20,
2627
},
28+
gitHubLink: {
29+
color: 'inherit',
30+
'&:visited' : {
31+
color: 'inherit',
32+
},
33+
},
2734
};
2835

2936
function ButtonAppBar(props) {
@@ -145,6 +152,22 @@ function ButtonAppBar(props) {
145152
>
146153
<SettingsIcon />
147154
</IconButton>
155+
<a
156+
className={classes.gitHubLink}
157+
href="https://github.com/magjac/graphviz-visual-editor"
158+
target="_blank"
159+
rel="noreferrer noopener"
160+
>
161+
<IconButton
162+
color="inherit"
163+
aria-label="GitHub"
164+
>
165+
<GitHubIcon
166+
fontSize='inherit'
167+
viewBox='-2.4 -2.4 28.8 28.8'
168+
/>
169+
</IconButton>
170+
</a>
148171
<IconButton
149172
color="inherit"
150173
aria-label="Help"

‎src/GitHubIcon.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import React from 'react';
2+
import SvgIcon from '@material-ui/core/SvgIcon';
3+
4+
function GitHubIcon(props) {
5+
return (
6+
<SvgIcon {...props}>
7+
<path d="M12.007 0C6.12 0 1.1 4.27.157 10.08c-.944 5.813 2.468 11.45 8.054 13.312.19.064.397.033.555-.084.16-.117.25-.304.244-.5v-2.042c-3.33.735-4.037-1.56-4.037-1.56-.22-.726-.694-1.35-1.334-1.756-1.096-.75.074-.735.074-.735.773.103 1.454.557 1.846 1.23.694 1.21 2.23 1.638 3.45.96.056-.61.327-1.178.766-1.605-2.67-.3-5.462-1.335-5.462-6.002-.02-1.193.42-2.35 1.23-3.226-.327-1.015-.27-2.116.166-3.09 0 0 1.006-.33 3.3 1.23 1.966-.538 4.04-.538 6.003 0 2.295-1.5 3.3-1.23 3.3-1.23.445 1.006.49 2.144.12 3.18.81.877 1.25 2.033 1.23 3.226 0 4.607-2.805 5.627-5.476 5.927.578.583.88 1.386.825 2.206v3.29c-.005.2.092.393.26.507.164.115.377.14.565.063 5.568-1.88 8.956-7.514 8.007-13.313C22.892 4.267 17.884.007 12.008 0z" />
8+
</SvgIcon>
9+
);
10+
}
11+
12+
export default GitHubIcon;

0 commit comments

Comments
 (0)