Skip to content

Update README.md #127

@Nielswps

Description

@Nielswps

The README.md is currently outdated. It should be updated to use examples instead of samples and Reveaal is currently misspelled. I also think it would be advantageous to include a link to the Ecdar/ECDAR repository for downloading releases.

All in all, the following things should be updated/added:

  • Correct spelling mistakes
  • Add an information box pointing to ECDAR if the goal is usage and not development
    - [ ] Rewrite Sample Projects to use examples and maybe a short description of what is included, what they can be used for, etc.
  • Rewrite Engine Configuration to include how to actually configure the engines in the GUI
    • Default engines are automatically picked up on the first startup
    • How to add custom engines
  • Add a Contributing section to inform new developers about how they best contribute to the project

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions