From ce75ea8a60343f51747848cf7f6a0db87f335924 Mon Sep 17 00:00:00 2001 From: Peisong Xiao Date: Wed, 25 Jun 2025 23:19:07 -0400 Subject: [PATCH] revised README, added section about style --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 52bc963..101d66e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ ROSE is part of the larger FLORA project, see [link here] for details. - [Getting started](#getting-started) - [Requirements](#requirements) - [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) - [The planning](#the-planning) - [The action](#the-action) @@ -52,11 +54,18 @@ TBD ### Deploying the slaves/peripheral modules on the FPGA fabric TBD -## Protocol specifications -See [`protocol.md`](protocol.md) for details. +## Coding in style +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. +See [`protocol.md`](protocol.md) for details. + ## The planning See the plan in [`plan.md`](plan.md). This file also contains short summaries of what I did at each step.