search

GaloisInc / csaf

Control Systems Analysis Framework - a framework to minimize the effort required to evaluate, implement, and verify controller design (classical and learning enabled) with respect to the system dynamics.
BSD 3-Clause "New" or "Revised" License
11 stars 4 forks source link

Update the README #6

Closed podhrmic closed 3 years ago

podhrmic commented 3 years ago

In GitLab by @bauer-matthews on Aug 4, 2020, 19:03

podhrmic commented 3 years ago

In GitLab by @bauer-matthews on Aug 5, 2020, 08:05

The README should have enough information such that a sub can:

We will need to capture software dependencies for both the docker and non-docker version.

podhrmic commented 3 years ago

In GitLab by @bauer-matthews on Aug 5, 2020, 08:11

We are going to assume there is a fixed directory layout for a CSAF system. We need to document this.

podhrmic commented 3 years ago

In GitLab by @bauer-matthews on Aug 5, 2020, 08:13

We also need to document how to write a custom component / system. This should is probably beyond the scope of the README. We can point to the pdf manual.

podhrmic commented 3 years ago

In GitLab by @podhrmic on Sep 22, 2020, 11:03

@EthanJamesLew@bauer-matthews do you want to give this one a try, or would you prefer if I draft an update?

podhrmic commented 3 years ago

In GitLab by @podhrmic on Sep 25, 2020, 15:59

Fold parts of the current presentation into the README

podhrmic commented 3 years ago

In GitLab by @podhrmic on Sep 25, 2020, 17:26

Also describe the release process, before making the release.

podhrmic commented 3 years ago

In GitLab by @podhrmic on Sep 28, 2020, 11:43

Done in !49