Add project files.
This commit is contained in:
67
README.md
Normal file
67
README.md
Normal file
@@ -0,0 +1,67 @@
|
||||
|
||||
# Nodify <img src="https://user-images.githubusercontent.com/12727904/195416464-cbe7e3be-a372-4a17-a4be-a868059b9d7e.png" width="120px" alt="Nodify" align="right">
|
||||
|
||||
[](https://www.nuget.org/packages/Nodify/)
|
||||
[](https://www.nuget.org/packages/Nodify)
|
||||
[](https://github.com/miroiu/nodify/blob/master/LICENSE)
|
||||
[](https://github.com/miroiu/nodify/wiki)
|
||||
|
||||
A collection of highly performant controls for node-based editors designed for MVVM.
|
||||
|
||||
> [!TIP]
|
||||
> There is now a fantastic Avalonia port available! You can check it out [here](https://github.com/BAndysc/nodify-avalonia). Huge thanks to [BAndysc](https://github.com/BAndysc) who made this possible!
|
||||
|
||||
## 🚀 Examples of node-based applications
|
||||
|
||||
🔶 A canvas application where you can draw and connect shapes.
|
||||
|
||||
> [Examples/Nodify.Shapes](Examples/Nodify.Shapes)
|
||||
|
||||

|
||||
|
||||
🎨 A playground application where you can try all the available settings.
|
||||
|
||||
> [Examples/Nodify.Playground](Examples/Nodify.Playground)
|
||||
|
||||

|
||||
|
||||
🌓 A state machine where each state represents an executable action, and each transition represents a condition for executing the next action.
|
||||
|
||||
> [Examples/Nodify.StateMachine](Examples/Nodify.StateMachine)
|
||||
|
||||

|
||||
|
||||
💻 A simple "real-time" calculator where each node represents an operation that takes input and feeds its output into other node's input.
|
||||
|
||||
> [Examples/Nodify.Calculator](Examples/Nodify.Calculator)
|
||||
|
||||

|
||||
|
||||
## 📥 Installation
|
||||
Use the NuGet package manager to install Nodify.
|
||||
|
||||
```
|
||||
Install-Package Nodify
|
||||
```
|
||||
|
||||
## ⭐️ Features
|
||||
|
||||
- Designed from the start to work with **MVVM**
|
||||
- **No dependencies** other than WPF
|
||||
- **Optimized** for interactions with hundreds of nodes at once
|
||||
- Built-in dark and light **themes**
|
||||
- **Selecting**, **zooming**, **panning** with **auto panning** when close to edge
|
||||
- **Select**, **move** and **connect** nodes
|
||||
- Ready for undo/redo
|
||||
- Configurable input gestures for each action
|
||||
- Built-in keyboard navigation system
|
||||
- Lots of **configurable** dependency properties
|
||||
- Example applications: 🎨 [**Playground**](Examples/Nodify.Playground), 🌓 [**State machine**](Examples/Nodify.StateMachine), 💻 [**Calculator**](Examples/Nodify.Calculator), 🔶 [**Canvas**](Examples/Nodify.Shapes)
|
||||
|
||||
## 📝 Documentation
|
||||
|
||||
Check out the [wiki](https://github.com/miroiu/nodify/wiki) and the [changelog](CHANGELOG.md) in github.
|
||||
|
||||
## ❤️ [Contributing](CONTRIBUTING.md)
|
||||
|
||||
Helping with documentation, bug reports, pull requests or anything else is very welcome.
|
||||
Reference in New Issue
Block a user