Skip to content

Commit 2deb044

Browse files
Improved README.md and added showcase for CANdevStudio (paceholder#322)
1 parent 95b5d8f commit 2deb044

File tree

2 files changed

+43
-17
lines changed

2 files changed

+43
-17
lines changed

README.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Purpose
1+
# Qt NodeEditor
22

33
**NodeEditor** is conceived as a general-purpose Qt-based library aimed at
44
graph-controlled data processing. Nodes represent algorithms with certain inputs
@@ -16,19 +16,38 @@ data and propagates is further.
1616
Each change in the source node is immediately propagated through all the
1717
connections updating the whole graph.
1818

19-
### Platforms
19+
## Navigation
20+
21+
- [Navigation](#navigation)
22+
- [Platforms](#platforms)
23+
- [Dependencies](#dependencies)
24+
- [Current state](#current-state)
25+
- [Building](#building)
26+
- [Linux](#linux)
27+
- [Qt Creator](#qt-creator)
28+
- [>>> Version 3 Roadmap <<<](#-version-3-roadmap-)
29+
- [Citing](#citing)
30+
- [Youtube video:](#youtube-video)
31+
- [Now with styles](#now-with-styles)
32+
- [Buy me a beer](#buy-me-a-beer)
33+
- [Showcase](#showcase)
34+
- [CANdevStudio](#candevstudio)
35+
- [Chigraph](#chigraph)
36+
- [Spkgen particle engine editor](#spkgen-particle-engine-editor)
37+
38+
## Platforms
2039

2140
* OSX (Apple Clang - LLVM 3.6), Linux (x64, gcc-7.0, clang-7): [![Build Status](https://travis-ci.org/paceholder/nodeeditor.svg?branch=master)](https://travis-ci.org/paceholder/nodeeditor)
2241
* Windows (msvc2019/Qt5/Win32, msvc2019/Qt6/x64): [![Build status](https://ci.appveyor.com/api/projects/status/wxp47wv3uyyiujjw/branch/master?svg=true)](https://ci.appveyor.com/project/paceholder/nodeeditor/branch/master)
2342

2443

25-
### Dependencies
44+
## Dependencies
2645

2746
* Qt >5.15
2847
* CMake 3.8
2948
* Catch2
3049

31-
### Current state
50+
## Current state
3251

3352
* Model-based nodes
3453
* Automatic data propagation
@@ -38,9 +57,9 @@ connections updating the whole graph.
3857
* JSON-based interface styles
3958
* Saving scenes to JSON files
4059

41-
### Building
60+
## Building
4261

43-
#### Linux
62+
### Linux
4463

4564
~~~
4665
git clone git@github.com:paceholder/nodeeditor.git
@@ -51,15 +70,15 @@ cmake ..
5170
make -j && make install
5271
~~~
5372

54-
#### Qt Creator
73+
### Qt Creator
5574

5675
1. Open `CMakeLists.txt` as project.
5776
2. If you don't have the `Catch2` library installed, go to `Build Settings`, disable the checkbox `BUILD_TESTING`.
5877
3. `Build -> Run CMake`
5978
4. `Build -> Build All`
6079
5. Click the button `Run`
6180

62-
### >>> Version 3 Roadmap <<<
81+
## >>> Version 3 Roadmap <<<
6382

6483
1. Headless mode. [done]
6584
You can create, populate, modify the derivative of AbstractGraphModel
@@ -81,7 +100,7 @@ make -j && make install
81100

82101
Any suggestions are welcome.
83102

84-
### Citing
103+
## Citing
85104

86105
Dmitry Pinaev et al, Qt Node Editor, (2017), GitHub repository, https://github.com/paceholder/nodeeditor
87106

@@ -98,23 +117,30 @@ BibTeX
98117
}
99118

100119

101-
### Youtube video:
120+
## Youtube video:
102121

103-
[![Youtube demonstration](https://bitbucket.org/paceholder/nodeeditor/raw/master/pictures/vid1.png)](https://www.youtube.com/watch?v=pxMXjSvlOFw)
122+
[![Youtube demonstration](pictures/vid1.png)](https://www.youtube.com/watch?v=pxMXjSvlOFw)
104123

105-
### Now with styles
124+
## Now with styles
106125

107126

108-
[![Styles](https://bitbucket.org/paceholder/nodeeditor/raw/master/pictures/style_example.png)](https://www.youtube.com/watch?v=i_pB-Y0hCYQ)
127+
[![Styles](pictures/style_example.png)](https://www.youtube.com/watch?v=i_pB-Y0hCYQ)
109128

110129

111-
### Buy me a beer
130+
## Buy me a beer
112131

113132
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/DmitryPinaev)
114133

115-
### Showcase
134+
## Showcase
116135

117-
#### [Chigraph](https://github.com/chigraph/chigraph)
136+
### [CANdevStudio](https://github.com/GENIVI/CANdevStudio)
137+
138+
Cost-effective, cross-platform replacement for CAN simulation software.
139+
CANdevStudio enables to simulate CAN signals such as ignition status, doors status or reverse gear by every automotive developer. Thanks to modularity it is easy to implement new, custom features.
140+
141+
[![Qt Design Studio](pictures/showcase_CANdevStudio.png)](https://youtu.be/1TfAyg6DG04?t=22)
142+
143+
### [Chigraph](https://github.com/chigraph/chigraph)
118144

119145
Chigraph is a programming language for beginners that is unique in that it is an
120146
intuitive flow graph:
@@ -123,7 +149,7 @@ intuitive flow graph:
123149

124150
It features easy bindings to C/C++, package management, and a cool interface.
125151

126-
#### [Spkgen particle engine editor](https://github.com/fredakilla/spkgen)
152+
### [Spkgen particle engine editor](https://github.com/fredakilla/spkgen)
127153

128154
![spkgen screenshot](pictures/spkgen.png)
129155

pictures/showcase_CANdevStudio.png

90.3 KB
Loading

0 commit comments

Comments
 (0)