<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html lang="en" style='--code-editor-font: var(--default-mono-font, "GitLab Mono"), JetBrains Mono, Menlo, DejaVu Sans Mono, Liberation Mono, Consolas, Ubuntu Mono, Courier New, andale mono, lucida console, monospace;'>
<head>
<meta content="text/html; charset=US-ASCII" http-equiv="Content-Type">
<title>
GitLab
</title>
<style data-premailer="ignore" type="text/css">
a { color: #1068bf; }
</style>
<style>img {
max-width: 100%; height: auto;
}
body {
font-size: .875rem;
}
body {
-webkit-text-shadow: rgba(255,255,255,.01) 0 0 1px;
}
body {
font-family: "GitLab Sans",-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Noto Sans",Ubuntu,Cantarell,"Helvetica Neue",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji"; font-size: inherit;
}
</style>
</head>
<body style='font-size: inherit; -webkit-text-shadow: rgba(255,255,255,.01) 0 0 1px; font-family: "GitLab Sans",-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Noto Sans",Ubuntu,Cantarell,"Helvetica Neue",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";'>
<div class="content">
<p style="color: #777777;">
<a href="https://gitlab.rtems.org/amar">Amar Takhar</a>
<a href="https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/94#note_120429">commented</a>:
</p>
<div class="md" style="position: relative; z-index: 1; color: #28272d; word-wrap: break-word;">
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial"><a href="https://gitlab.rtems.org/chris" data-reference-type="user" data-user="3" data-container="body" data-placement="top" class="gfm gfm-project_member js-user-link" title="Chris Johns" style="color: #0b5cad; background-color: #cbe2f9; border-radius: .25rem; margin-top: 0; padding: 0 2px;">@chris</a> I tried a stab at editing the README and gave up.</p>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">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:</p>
<h2 dir="auto" style="font-size: 1.5em; font-weight: 600; padding-bottom: .3em; border-bottom-width: 1px; border-bottom-color: #bfbfc3; border-bottom-style: solid; color: #28272d; margin: 24px 0 16px;" align="initial">
<a href="#dependencies" aria-hidden="true" class="anchor" id="user-content-dependencies" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Dependencies</h2>
<h3 dir="auto" style="font-size: 1.3em; margin: 24px 0 16px;" align="initial">
<a href="#python" aria-hidden="true" class="anchor" id="user-content-python" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Python</h3>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">...</p>
<h3 dir="auto" style="font-size: 1.3em; margin: 24px 0 16px;" align="initial">
<a href="#node" aria-hidden="true" class="anchor" id="user-content-node" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Node</h3>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">...</p>
<h3 dir="auto" style="font-size: 1.3em; margin: 24px 0 16px;" align="initial">
<a href="#tools" aria-hidden="true" class="anchor" id="user-content-tools" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Tools</h3>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">...</p>
<h2 dir="auto" style="font-size: 1.5em; font-weight: 600; padding-bottom: .3em; border-bottom-width: 1px; border-bottom-color: #bfbfc3; border-bottom-style: solid; color: #28272d; margin: 24px 0 16px;" align="initial">
<a href="#language" aria-hidden="true" class="anchor" id="user-content-language" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Language</h2>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">We use MarkDown and the MyST parser <urls></p>
<h3 dir="auto" style="font-size: 1.3em; margin: 24px 0 16px;" align="initial">
<a href="#images" aria-hidden="true" class="anchor" id="user-content-images" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Images</h3>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial"><here is how we handle images></p>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">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.</p>
<p dir="auto" style="color: #28272d; margin: 0 0 16px;" align="initial">We also have the user forums now to help with questions that can serve as an eratta</p>
<p dir="auto" style="color: #28272d; margin: 0;" align="initial">Comments?</p>
</div>
</div>
<div class="footer" style="margin-top: 10px;">
<p style="font-size: small; color: #737278;">
—
<br>
<a href="https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/94#note_120429">View it on GitLab</a>.
<br>
You're receiving this email because of your account on <a target="_blank" rel="noopener noreferrer" href="https://gitlab.rtems.org">gitlab.rtems.org</a>. <a href="https://gitlab.rtems.org/-/sent_notifications/bdd48db5aee2d30284b1c433cef93964/unsubscribe" target="_blank" rel="noopener noreferrer">Unsubscribe</a> from this thread · <a href="https://gitlab.rtems.org/-/profile/notifications" target="_blank" rel="noopener noreferrer" class="mng-notif-link">Manage all notifications</a> · <a href="https://gitlab.rtems.org/help" target="_blank" rel="noopener noreferrer" class="help-link">Help</a>
<script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","action":{"@type":"ViewAction","name":"View Issue","url":"https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/94#note_120429"}}</script>
</p>
</div>
</body>
</html>