Skip to content

Commit

Permalink
Clean up getting started guide (#3061)
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-bc authored Dec 10, 2024
1 parent 9367a3b commit f378b20
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 28 deletions.
20 changes: 12 additions & 8 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# F´ A Flight Software and Embedded Systems Framework
---
hide:
- toc
---

# Getting Started with F Prime

## Overview
F´ (F Prime) is a component-driven framework that enables rapid development and deployment of spaceflight and other embedded software applications. Originally developed at the Jet Propulsion Laboratory, F´ has been successfully deployed on several space applications. It is tailored but not limited to small-scale spaceflight systems such as CubeSats, SmallSats, and instruments.

F´ has the following features:
Expand All @@ -11,13 +15,13 @@ F´ has the following features:
- A standard library of flight-worthy components
- Testing tools for unit and system-level testing

## F´ External Resources
- [GitHub Repository](https://github.com/nasa/fprime)
- [Discussions](https://github.com/nasa/fprime/discussions)
- [Issues](https://github.com/nasa/fprime/issues)
- [Community GitHub Organization](https://github.com/fprime-community)
## Hello, World!

New users should start with the [Hello World tutorial](../tutorials-hello-world/docs/hello-world//). This tutorial walks through the F´ installation process, how to create a new project and how to design, implement, and test a basic F Prime application.


## Further References

To start with F´, follow the [installation guide](installing-fprime.md). Then follow our [tutorials](../documentation/tutorials/index.md), or inspect our [reference applications](https://github.com/fprime-community#references).
Here are some additional references to continue learning about F´:
- [More tutorials](../documentation/tutorials/)
- [F´ User Manual](../documentation/user-manual/)
17 changes: 0 additions & 17 deletions docs/getting-started/projects.md

This file was deleted.

4 changes: 1 addition & 3 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -271,9 +271,7 @@ nav:
- 'F´ Projects': overview/projects.md
- Getting Started:
- getting-started/index.md
- 'Installing F´': getting-started/installing-fprime.md
- 'F´ Features': getting-started/features.md
- 'F´ Projects': getting-started/projects.md
- 'Installation and Troubleshooting': getting-started/installing-fprime.md
- Documentation:
- documentation/index.md
- Tutorials:
Expand Down

0 comments on commit f378b20

Please sign in to comment.