README Improvements - Githubissues

Twigonometry / IsabelleDSL

IsabelleDSL (iDSL) is a framework for generating Domain-Specific Languages from specifications written in Isabelle

0 stars 0 forks source link

README Improvements #13

Open Twigonometry opened 2 years ago

Twigonometry commented 2 years ago

Add extra documentation to README.md:

[ ] Make documentation more concise
[ ] Add a 'why this framework?' section
[ ] Add descriptions for all parameters (perhaps copy the output of the --help flag)
[ ] Add subheadings e.g. for auto-testing commands
[ ] Describe what information included in verbose mode
[ ] Explain purpose of Intensional_Impossible.thy
[ ] Explain caveats of C code e.g. limited size of stack/queue

Twigonometry commented 2 years ago

Remind user they can add new cases to exec_commands if they wish to support new languages. For compiled languages, command should hopefully be auto-formatted #20