Skip to content

Kevsterking/Synopsis

Repository files navigation

Synopsis

Synopsis is designed to make it easier to organize yourself or any collection of collaborators.

Description

Managing and accurately describing a system, meaning all of its parts and their relations, can be difficult. Especially given today's most common practice for doing this - plain text.

Synopsis is designed to give the power to create the simplest and most understandable overview of any type of system. It does this with the drawing of diagrams similar to block diagrams. A diagram consists of certain elements:

  • Nodes (nodes are the atoms of a diagram - they represent something).
  • Edges (edges represents the relationships between nodes and describe the way in which they interract).

Here is a demonstration of how nodes and edges may be depicted:

Nodes & Edges

Installation

--TODO--

Usage

--TODO--

Credits

--TODO--

License

--TODO--

Coming

  • running/compiling/debugging code directly inside synopsis with workflow described by the diagram
  • Git integration directly with the diagrams

About

Flowcharts For Planning & Building Projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published