state-machine-cat 15.0.0 → 15.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -38,10 +38,10 @@ To enable me to make state charts ...
38
38
 
39
39
  - ... that look _good_
40
40
  - ... with the least effort possible
41
- - ... whithout having to interact with drag and drop tools. Entering text
41
+ - ... without having to interact with drag and drop tools. Entering text
42
42
  is fine, doing my own layout is not.
43
43
  - ... without having to dive into GraphViz `dot` each time. GraphViz is cool,
44
- but is was not designed to write & maintain conceptual documents in
44
+ but was not designed to write & maintain conceptual documents in
45
45
  (_You'll know what I'm talking about if you ever tried to get it to draw nested nodes. Or edges between those._ )
46
46
 
47
47
  ## Usage
@@ -88,7 +88,7 @@ smcat -T dot docs/sample.smcat -o - | dot -T svg -odoc/sample.svg
88
88
  Leaving the options at the default settings usually deliver the best
89
89
  results already, so if they bewilder you: don't worry.
90
90
 
91
- When you pass the `--desugar` (⨻ experimental) switch, state-machine-cat will,
91
+ When you pass the `--desugar` (experimental) switch, state-machine-cat will,
92
92
  before rendering, transform some pseudo states into transitions - see
93
93
  [de-sugaring state machines](docs/desugar.md) for details.
94
94
 
@@ -371,7 +371,7 @@ a => Aahnohd: [hit by meteorite];
371
371
  - Labels have the same restriction as activities, except they allow for `,` too.
372
372
  - State declaration precedence is: deep wins from shallow; explicit wins from
373
373
  implicit
374
- - It's possible to declare the same state multiple times on the same level, buts
374
+ - It's possible to declare the same state multiple times on the same level, but
375
375
  smcat will take the last declaration into account only. For example:
376
376
 
377
377
  This
@@ -471,7 +471,7 @@ playing => playing: ingest food;
471
471
  playing => playing [type=internal]: ingest drink;
472
472
  ```
473
473
 
474
- <img width="346" alt="internal transition" src="docs/pics/13internal_transition.png">
474
+ <img width="346" alt="internal transition" src="https://raw.githubusercontent.com/sverweij/state-machine-cat/main/docs/pics/13internal_transition.png">
475
475
 
476
476
  #### marking states _active_
477
477
 
@@ -534,7 +534,7 @@ As of version 7.4.0 you can use the keyword `class` as an extended keyword on
534
534
  both states and transitions. When you render `svg` or `dot` you'll see what you
535
535
  entered there in the output in the `class` attributes of their respective
536
536
  elements, along with the type of element (either 'state' or 'transition') and
537
- optionally the type of state or transtion (e.g. for state: 'initial', 'regular',
537
+ optionally the type of state or transition (e.g. for state: 'initial', 'regular',
538
538
  'final' etc.).
539
539
 
540
540
  For example, this ...
@@ -638,7 +638,7 @@ The values you can use for the `type` of a state:
638
638
  #### grammar
639
639
 
640
640
  I made the parser with peggy - you can find it at
641
- [src/parse/smcat-parser.peggy](src/parse/smcat/smcat-parser.peggy), and
641
+ [src/parse/smcat/smcat-parser.peggy](src/parse/smcat/smcat-parser.peggy), and
642
642
  railroad diagrams generated from these on [state-machine-cat.js.org/grammar.html](https://state-machine-cat.js.org/grammar.html)
643
643
 
644
644
  ## Status