Browse Source

Include initialization sequence diagram. Until better tooling I created the .puml file and converted it to PNG to include it into the README.

develop
Christian Aust 5 months ago
parent
commit
dd5c268fe0
  1. 4
      README.md
  2. BIN
      doc/images/general_sequence.png
  3. 24
      doc/images/general_sequence.puml

4
README.md

@ -103,6 +103,10 @@ Multiple target definitions may be given on the command line. [Ruby glob pattern
The software was written using the Ruby programming language. The project uses standard Ruby technology like RSpec and Bundler, and features RVM-integration to ease development.
## Initialization flow
![](doc/images/general_sequence.png)
## Unit tests
Run unit test by executing `rake`. Any other option provided by [RSpec](https://rspec.info/) also works.

BIN
doc/images/general_sequence.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

24
doc/images/general_sequence.puml

@ -0,0 +1,24 @@
@startuml
participant "exe/sanity" as exe
participant "Sanity::Options" as options
participant "Sanity::Runner" as runner
participant "Sanity::Suite" as suite
participant "Sanity::Output::*" as output
activate exe
exe -> options: ::parse!
exe -> runner: #initialize(targets, options)
loop Suites
runner -> suite: #run
end
loop Outputs
runner -> output: #process
end
deactivate exe
@enduml
Loading…
Cancel
Save