nasa/fprime
1
0
Fork 0
mirror of https://github.com/nasa/fprime.git synced 2025-12-10 17:47:10 -06:00
Code Issues Packages Projects Releases 34 Wiki Activity

Clean up getting started guide (#3061)

Browse Source
This commit is contained in:
Thomas Boyer-Chammard 2024-12-10 11:22:54 -08:00 committed by GitHub
parent 9367a3ba2f
commit f378b20907
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 13 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/getting-started/index.md
View File

@ -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:
@ -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
docs/getting-started/projects.md
View File

@ -1,17 +0,0 @@
# F´ Projects
View F Prime Projects showcase here: [Projects](../overview/projects.md)
Here are the projects and programs identified applying the F´ code:
|**_Project/Program_**| **_Type_** | **_NASA Center / Company_** | **_OS_** | **_HW Platform_** | **_Launch Date_**| **_End of Mission_** | **_Note_**|
|:---|:---|:---|:---|:---|:---|:---|:---|
| [ISS-RapidScat (International Space Station Rapid Scatterometer)](https://www.jpl.nasa.gov/missions/international-space-station-rapid-scatterometer-iss-rapidscat) | Instrument | [NASA's JPL](https://www.jpl.nasa.gov/) | | | Sep. 21, 2014 | Nov. 18, 2018 | Target: Earth |
| [ASTERIA (Arcsecond Space Telescope Enabling Research in Astrophysics)](https://www.jpl.nasa.gov/missions/arcsecond-space-telescope-enabling-research-in-astrophysics-asteria) | Technology Demonstration, CubeSat/SmallSat | [NASA's JPL](https://www.jpl.nasa.gov/) | Linux | PowerPC | Aug. 14, 2017 | End of Feb. 2020 | [Publication](https://digitalcommons.usu.edu/cgi/viewcontent.cgi?article=4067&context=smallsat) - Target: Exoplanets |
| [Mars Helicopter (Ingenuity)](https://mars.nasa.gov/technology/helicopter/) | Airborne | [NASA's JPL](https://www.jpl.nasa.gov/) | Linux | Qualcomm’s Snapdragon 801 | Jul. 30, 2020 | Ongoing | Target: Mars |
| [Lunar Flashlight CubeSat](https://www.jpl.nasa.gov/missions/lunar-flashlight) | Technology Demonstration, CubeSat/SmallSat | [NASA's JPL](https://www.jpl.nasa.gov/) | VxWorks | Sphinx (GR712 - LEON3FT SPARC) | Dec. 11, 2022 |Ongoing | [Publication](https://digitalcommons.usu.edu/cgi/viewcontent.cgi?article=5263&context=smallsat) - Target: Moon |
| [Near Earth Asteroid Scout CubeSat](https://www.jpl.nasa.gov/missions/near-earth-asteroid-scout-neascout) | Technology Demonstration, CubeSat/SmallSat | [NASA's JPL](https://www.jpl.nasa.gov/) | VxWorks | Sphinx (GR712 - LEON3FT SPARC) | Nov. 16, 2022 | Ongoing | [Publication](https://digitalcommons.usu.edu/cgi/viewcontent.cgi?article=5263&context=smallsat) - Target: Asteroids and Comets |
| [OWLS (Ocean Worlds Life Surveyor instrument)](https://www.jpl.nasa.gov/go/owls) | Instrument | [NASA's JPL](https://www.jpl.nasa.gov/) | | | | | |
| [CADRE (Cooperative Autonomous Distributed Robotic Explorers)](https://www.nasa.gov/directorates/spacetech/game_changing_development/projects/CADRE) | Robot | [NASA's JPL](https://www.jpl.nasa.gov/) | | | | | |
| [COLDArm (Cold Operable Lunar Deployable Arm)](https://www.nasa.gov/feature/cold-operable-lunar-deployable-arm-coldarm/) | Robotic arm | [NASA's JPL](https://www.jpl.nasa.gov/) | | | | | |

4
docs/mkdocs.yml
View File

@ -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: