Merge pull request #45 from aljen/update-readme

Update readme
aljen · Feb 17, 2018 · 8d4a3e4 · 8d4a3e4
2 parents 6fdf4cb + fcee0a8
commit 8d4a3e4
Show file tree

Hide file tree

Showing 21 changed files with 207 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3,9 +3,156 @@
 [![Build status][appveyor-badge]][appveyor-link]
 [![MIT License][license-badge]](LICENSE)
 
+## Screenshots
+
 ![spaghetti.gif](docs/spaghetti.gif)
 ![spaghetti2.gif](docs/spaghetti2.gif)
 
+## Features
+
+* Feedback loops
+* Custom plugins
+* Run-time wiring
+* Plugins
+
+## Rich library of built-in elements
+
+### Logic Gates
+
+* AND
+* NAND
+* NOR
+* NOT
+* OR
+
+![logic_gates.gif](docs/logic_gates.gif)
+
+### Conditionals
+
+* A ≥ B
+* A > B
+* A ≡ B
+* A < B
+* A ≤ B
+
+![logic_conditionals.gif](docs/logic_conditionals.gif)
+
+### Memory
+
+* Set-Reset
+* Reset-Set
+
+![logic_memory.gif](docs/logic_memory.gif)
+
+### Multiplexing
+
+* Multiplexer
+* Demultiplexer
+
+![logic_multiplexing.gif](docs/logic_multiplexing.gif)
+
+### Edge detection
+
+* Rising edge detection
+
+![logic_detect_rising.gif](docs/logic_detect_rising.gif)
+
+* Falling edge detection
+
+![logic_detect_falling.gif](docs/logic_detect_falling.gif)
+
+### Math
+
+* abs(VALUE)
+
+![math_abs.gif](docs/math_abs.gif)
+
+* sin(ANGLE)
+* cos(ANGLE)
+
+![math_sincos.gif](docs/math_sincos.gif)
+
+* lerp(MIN, MAX, T)
+
+![math_lerp.gif](docs/math_lerp.gif)
+
+* sign
+
+![math_sign.gif](docs/math_sign.gif)
+
+* add
+* subtract
+* multiply
+* divide
+
+![math_operations.gif](docs/math_operations.gif)
+
+* add_if
+* subtract_if
+* multiply_if
+* divide_if
+
+![math_operations_if.gif](docs/math_operations_if.gif)
+
+* BCD
+
+![spaghetti.gif](docs/spaghetti.gif)
+
+### Pneumatic
+
+* Tank
+* Valve
+
+### Timers
+
+* Simulation delta time
+
+![timers_delta_time.gif](docs/timers_delta_time.gif)
+
+* Clock
+
+![logic_gates.gif](docs/logic_gates.gif)
+
+* T_ON
+
+![timers_t_on.gif](docs/timers_t_on.gif)
+
+* T_OFF
+
+![timers_t_off.gif](docs/timers_t_off.gif)
+
+* T_PULSE
+
+![logic_detect_falling.gif](docs/logic_detect_falling.gif)
+
+### Values
+
+* Const bool
+* Const integer
+* Const float
+
+![values_consts.gif](docs/values_consts.gif)
+
+* min(A, B)
+* max(A, B)
+* clamp(VALUE, MIN, MAX)
+
+![values_min_max_clamp.gif](docs/values_min_max_clamp.gif)
+
+* Degree to radian
+* Radian to degree
+
+![values_convert_angle.gif](docs/values_convert_angle.gif)
+
+* Int to float
+* Float to integer
+
+![values_convert_int_float.gif](docs/values_convert_int_float.gif)
+
+* Characteristic curve with editor
+
+![values_characteristic_curve.gif](docs/values_characteristic_curve.gif)
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](https://github.com/aljen/spaghetti/blob/master/LICENSE) file for details.

diff --git a/docs/logic_conditionals.gif b/docs/logic_conditionals.gif
diff --git a/docs/logic_detect_falling.gif b/docs/logic_detect_falling.gif
diff --git a/docs/logic_detect_rising.gif b/docs/logic_detect_rising.gif
diff --git a/docs/logic_gates.gif b/docs/logic_gates.gif
diff --git a/docs/logic_memory.gif b/docs/logic_memory.gif
diff --git a/docs/logic_multiplexing.gif b/docs/logic_multiplexing.gif
diff --git a/docs/math_abs.gif b/docs/math_abs.gif
diff --git a/docs/math_lerp.gif b/docs/math_lerp.gif
diff --git a/docs/math_operations.gif b/docs/math_operations.gif
diff --git a/docs/math_operations_if.gif b/docs/math_operations_if.gif
diff --git a/docs/math_sign.gif b/docs/math_sign.gif
diff --git a/docs/math_sincos.gif b/docs/math_sincos.gif
diff --git a/docs/timers_delta_time.gif b/docs/timers_delta_time.gif
diff --git a/docs/timers_t_off.gif b/docs/timers_t_off.gif
diff --git a/docs/timers_t_on.gif b/docs/timers_t_on.gif
diff --git a/docs/values_characteristic_curve.gif b/docs/values_characteristic_curve.gif
diff --git a/docs/values_consts.gif b/docs/values_consts.gif
diff --git a/docs/values_convert_angle.gif b/docs/values_convert_angle.gif
diff --git a/docs/values_convert_int_float.gif b/docs/values_convert_int_float.gif
diff --git a/docs/values_min_max_clamp.gif b/docs/values_min_max_clamp.gif