revised README, added section about style

This commit is contained in:
2025-06-25 23:19:07 -04:00
parent b478633c81
commit ce75ea8a60

View File

@ -11,7 +11,9 @@ ROSE is part of the larger FLORA project, see [link here] for details.
- [Getting started](#getting-started) - [Getting started](#getting-started)
- [Requirements](#requirements) - [Requirements](#requirements)
- [Deploying the masters/controllers on the SBCs](#deploying-the-masterscontrollers-on-the-sbcs) - [Deploying the masters/controllers on the SBCs](#deploying-the-masterscontrollers-on-the-sbcs)
- [Deploying the slaves/peripheral modules on the FPGA fabric](#deploying-the-slavesperipheral-modules-on-the-fpga-fabric) - [Deploying the slaves/peripheral modules on the FPGA
fabric](#deploying-the-slavesperipheral-modules-on-the-fpga-fabric)
- [Coding in style](#coding-in-style)
- [Protocol specifications](#protocol-specifications) - [Protocol specifications](#protocol-specifications)
- [The planning](#the-planning) - [The planning](#the-planning)
- [The action](#the-action) - [The action](#the-action)
@ -52,11 +54,18 @@ TBD
### Deploying the slaves/peripheral modules on the FPGA fabric ### Deploying the slaves/peripheral modules on the FPGA fabric
TBD TBD
## Protocol specifications ## Coding in style
See [`protocol.md`](protocol.md) for details. Coding style is important. Code is for both the human and the
machine, the machine doesn't care about style, but humans do. A good
style would help development a lot.
See [`style.md`](style.md) for details.
## Protocol specifications
ROSE was designed to embrace newer possibilities as development continues. ROSE was designed to embrace newer possibilities as development continues.
See [`protocol.md`](protocol.md) for details.
## The planning ## The planning
See the plan in [`plan.md`](plan.md). This file also contains short summaries of See the plan in [`plan.md`](plan.md). This file also contains short summaries of
what I did at each step. what I did at each step.