Skip to content

Commit

Permalink
Update Intro to User's Guide
Browse files Browse the repository at this point in the history
Fix link; fix typography
  • Loading branch information
bocchino committed Jul 23, 2024
1 parent 26bfc10 commit 04bd5a9
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/fpp-spec.html
Original file line number Diff line number Diff line change
Expand Up @@ -8551,7 +8551,7 @@ <h3 id="Analysis-and-Translation_Translation-Tools">20.4. Translation Tools</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-25 13:02:44 -0700
Last updated 2024-07-22 17:41:09 -0700
</div>
</div>
<script src="code-prettify/run_prettify.js"></script>
Expand Down
15 changes: 7 additions & 8 deletions docs/fpp-users-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -749,20 +749,19 @@ <h2 id="Introduction">1. Introduction</h2>
create, e.g., deployable flight software (FSW) programs and ground data environments.</p>
</div>
<div class="paragraph">
<p>The name "F Double Prime" (or F'') deliberately suggests the idea of a
"derivative"
of F Prime (or F').
By "integrating" an FPP model (i.e., running the tools) you get a partial
FSW implementation in the F Prime framework; and then by "integrating" again
<p>The name &#8220;F Double Prime&#8221; (or F&Prime;) deliberately suggests the idea of a
&#8220;derivative&#8221;
of F Prime (or F&prime;).
By &#8220;integrating&#8221; an FPP model (i.e., running the tools) you get a partial
FSW implementation in the F Prime framework; and then by &#8220;integrating&#8221; again
(i.e., providing
the project-specific C&#43;&#43; implementation) you get a FSW application.</p>
</div>
<div class="paragraph">
<p><strong>Purpose:</strong> The purpose of this document is to describe FPP in a way that is accessible
to users, including beginning users.
A more detailed and precise description is available in
<a href="https://fprime-community.github.io/fpp/fpp-spec.html"><em>The FPP Language
Specification</em></a>.
<a href="https://nasa.github.io/fpp/fpp-spec.html"><em>The FPP Language Specification</em></a>.
We recommend that you read this document before consulting that one.</p>
</div>
<div class="paragraph">
Expand Down Expand Up @@ -12294,7 +12293,7 @@ <h4 id="Writing-C-Plus-Plus-Implementations_Implementing-Deployments_Public-Symb
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-26 08:38:10 -0700
Last updated 2024-07-22 17:45:06 -0700
</div>
</div>
<script src="code-prettify/run_prettify.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ <h1>F Prime Prime (FPP)</h1>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-25 13:07:03 -0700
Last updated 2024-07-20 12:45:03 -0700
</div>
</div>
</body>
Expand Down
13 changes: 6 additions & 7 deletions docs/users-guide/Introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,18 @@ In this document, we will call these languages the *target languages*.
Developers may combine code generated from FPP with code written by hand to
create, e.g., deployable flight software (FSW) programs and ground data environments.

The name "F Double Prime" (or F'') deliberately suggests the idea of a
"derivative"
of F Prime (or F').
By "integrating" an FPP model (i.e., running the tools) you get a partial
FSW implementation in the F Prime framework; and then by "integrating" again
The name "`F Double Prime`" (or F&Prime;) deliberately suggests the idea of a
"`derivative`"
of F Prime (or F&prime;).
By "`integrating`" an FPP model (i.e., running the tools) you get a partial
FSW implementation in the F Prime framework; and then by "`integrating`" again
(i.e., providing
the project-specific {cpp} implementation) you get a FSW application.

*Purpose:* The purpose of this document is to describe FPP in a way that is accessible
to users, including beginning users.
A more detailed and precise description is available in
https://fprime-community.github.io/fpp/fpp-spec.html[_The FPP Language
Specification_].
https://nasa.github.io/fpp/fpp-spec.html[_The FPP Language Specification_].
We recommend that you read this document before consulting that one.

*Overview:* The rest of this document proceeds as follows.
Expand Down

0 comments on commit 04bd5a9

Please sign in to comment.