rsouth / sequencer

Sequence diagram generator with simple text based grammar, to make it quick and easy to share ideas and document your system. Copy to clipboard for sharing on chat, or export as .PNG.

sequencer is a simple diagramming tool to make it easy for developers to share ideas

Highlights • Get Started • Demo • Themes • Download • Contributing • Credits • License

✅ What is sequencer?

Sequencer allows you to create simple and clear sequence diagrams, based on a simple grammar. Your diagram is drawn in real-time as you type, and is designed to be:

• easy to edit
• easy to share
• easy to version control

Sequencer is free and open-source, distributed as a single .exe (no installer), and has just the features you need to share and document your idea quickly.

🎥 Demo

⚡ Simple to get started

💬 Describe your sequence

Client -> Server: Request
Server -> Server: Parses request
Server -> Service: Query
Service -> Server: Data
Server -> Client: Response

💥 Your diagram is ready to go

• paste right in to chat, email, your wiki page
• export as a .png file
• share the source, or better yet - version control it!

See the Grammar page on the wiki for details of the current grammar.

🎨 Themes

Support for basic themes is progressing, the "Sketchy" theme is available since v0.0.3-pre-alpha.

Theme information can be found on the Themes wiki page.

🔨 Building

qmake
nmake release

https://github.com/rsouth/sequencer/wiki/Building

🚀 Download

Releases Page

Latest

Please download the latest release.

v0.0.3 pre-alpha 🍒

• Significant refactoring of rendering
• Added 'Sketchy' theme

v0.0.2 pre-alpha

• Rendering is now done in Qt QPainter on a QPixmap rather than using CImg
• More functional UI
  • Dirty checks before New, Open
  • Create New button works
  • Undo/redo functionality in text editor
• Code review items since last release
• Rendering changes:
  • Default font sizes are now smaller
  • Smaller arrow-heads
  • Rounded boxes around participant headers

v0.0.1 pre-alpha

• Grammar parity with jSequencer
  • Participants and messages
  • Synchronous and asynchronous messages
  • Self-referential messages
  • Reply messages
  • Header information (title, author, date)
• Qt UI implementation
• Sharing options (clipboard, .png export)

👍 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

🙏 Credits / Attributions

🖼️ Icons

Toolbar icons made by Dave Gandy from www.flaticon.com.

💡 Inspiration

WebSequenceDiagrams which is an online text-based sequence diagram generator with a commercial offering.

Sequencer is a C++ re-write of my own project jSequencer.

📘 License

This project is licensed under the terms of the GNU General Public License v3.0.