Skip to content
Martin Kojtal edited this page Jan 5, 2020 · 19 revisions

Welcome on the wiki pages for the embedded project generator repository. Project generator might be reference here as progen.

The wiki is for progen v0.9.x

Project generator is on pypi - project generator. You can download it from there or use the github repository as a submodule in your project (a read about submodules Git submodules).

Good example how to use progen can be found here

Progen commands

There are 6 main commands, many of them have subcommands available:

  • init - to create a project records from a directory
  • generate - to generate a project
  • clean - to clean generated projects
  • list - to list targets, tools or projects
  • build - to build a project

More description can be found in Commands

Start generating

For starters, read our Getting started guide - how to use progen for your project using yaml files.

If you are interested in how to interact with progen in python (use it in your module), please look at internal design documentation Design document

Contributing

For contributors, look at Targets and Tools pages where is described how to add a new tool or a target.

Sharing is caring - If you find an issue, any limitation, or possible improvements, please report it on github. Any feedback is appreciated !

EnjoY!