/fsm_gen

C-code FSM generator from YAML specifications

Primary LanguagePythonMIT LicenseMIT

fsm_gen

C-code FSM generator from YAML specifications

Initial requirements for the project

You should have Python dependency management called Poetry installed on your system.

Install

From the root of the project

poetry install

Now you can activate the environment

poetry shell

Run fsm CLI

When the environment is activated you will have access to fsm CLI. Run

fsm --help

to see available options.

Here is an example how to generate C code from a YAML file:

fsm c-from-yaml docs/ex1.yaml generated/ex1

Now checkout generated/ex1 directory for generated files.

Build and serve documentation

There is a documentation system based on mkdocs.

You can start docs server locally by running:

mkdocs serve