Amar Takhar commented: 
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/94#note_120429


@chris I tried a stab at editing the README and gave up.

I think most of it should be killed.  Do we really need to go through how to 
install all these packages locally?  I think all these years later we should be 
able to list our requirements and users should use whatever their local system 
requires. Basically distill it down to:

## Dependencies

### Python

...

### Node

...

### Tools

...

## Language

We use MarkDown and the MyST parser \<urls\>

### Images

\<here is how we handle images\>

What else needs to be added?  We can have a blurb about plantuml and dita but 
we go into too many details and the README is overwhelming I feel that 10 years 
later there is tons of details on how to get these widely used packages online.

We also have the user forums now to help with questions that can serve as an 
eratta 

Comments?

-- 
View it on GitLab: 
https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/94#note_120429
You're receiving this email because of your account on gitlab.rtems.org.


_______________________________________________
bugs mailing list
[email protected]
http://lists.rtems.org/mailman/listinfo/bugs

Reply via email to