Skip to content

Commit 0fb9954

Browse files
committed
Improve README.rst
1 parent 576550a commit 0fb9954

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

README.rst

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,27 @@ Dependencies
7878
* Catch2
7979

8080

81-
Current State
82-
=============
81+
Current State (v3)
82+
==================
8383

84-
* Model-based nodes
85-
* Automatic data propagation
84+
* Model-based graph
85+
* Headless mode
86+
You can create, populate, modify the derivative of ``AbstractGraphModel``
87+
without adding it to the actual Flow Scene. The library is now designed to be
88+
general-purpose graph visualization and modification tool, without
89+
specialization on only data propagation.
90+
* Automatic data propagation built on top of the graph-model code
91+
The library could be used for both pure graph visualization purposes and for
92+
originally implemented data propagation.
93+
* Dynamic ports
8694
* Datatype-aware connections
8795
* Embedded Qt widgets
8896
* One-output to many-input connections
8997
* JSON-based interface styles
9098
* Saving scenes to JSON files
99+
* Custom Node Geometry
100+
* Vertical and Horizontal graph layouts
101+
* Undo/Redo, Duplication (CTRL+D)
91102

92103

93104
Building
@@ -127,20 +138,6 @@ With Cmake using `vcpkg`
127138
-DCMAKE_TOOLCHAIN_FILE=<vcpkg_dir>/scripts/buildsystems/scripts/buildsystems/vcpkg.cmake
128139

129140

130-
Version 3 Highlights
131-
====================
132-
133-
#. Headless mode.
134-
You can create, populate, modify the derivative of AbstractGraphModel
135-
without adding it to the actual Flow Scene.
136-
The library is now designed to be general-purpose graph
137-
visualization and modification tool, without specialization on only
138-
data propagation.
139-
#. Build data propagation on top of the graph code.
140-
The library coudl be used for a pure grph visualization purposes as well as
141-
for originally implemented data propagation.
142-
143-
144141
Help Needed
145142
===========
146143

@@ -157,14 +154,14 @@ Contribution
157154
#. Be polite, respectful and collaborative.
158155
#. For submitting a bug:
159156

160-
#. Describe your environment (Qt version, compiler, OS etc)
161-
#. Describe steps to reproduce the issue
157+
#. Describe your environment (Qt version, compiler, OS etc)
158+
#. Describe steps to reproduce the issue
162159

163160
#. For submitting a pull request:
164161

165162
#. Create a proposal task first. We can come up with a better design together.
166-
#. Create a pull-request. If applicable create a simple example to your
167-
iescribe your problem in details, provide use cases,
163+
#. Create a pull-request. If applicable, create a simple example for your
164+
problem, describe the changes in details, provide use cases.
168165

169166
#. For submitting a development request:
170167

0 commit comments

Comments
 (0)