The README is a disaster area. Sort it out! Most of its content belongs somewhere else. It's time we started documenting software architecture---e.g. functional, process, deployment, implementation views, etc. At the moment just a few diagrams and paragraphs for each topic will do I reckon, i.e. no need for anything fancy, but having a compass will definitely help navigate through the code!
c0c0n3
commented
4 years ago
The README is a disaster area. Sort it out! Most of its content belongs somewhere else. It's time we started documenting software architecture---e.g. functional, process, deployment, implementation views, etc. At the moment just a few diagrams and paragraphs for each topic will do I reckon, i.e. no need for anything fancy, but having a compass will definitely help navigate through the code!