Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #114, Add new installation instructions to the readme #115

Conversation

JandlynBentley-at-NASA
Copy link
Contributor

@JandlynBentley-at-NASA JandlynBentley-at-NASA commented Jul 21, 2020

The following additions were made to improve novice user installation experience in the cFS README.md.

Describe the contribution
Added a brief introductory statement describing cFS to the top of the page.
Added prerequisite software (make, cmake, gcc, and git) instruction to the Setup section.
Added a statement specifying a possible third dependency, libcanberra-gtk-module, for the GroundSystem under the Send commands receive telemetry section.
Additionally, some typos were corrected.

Resolves: #114

Contributor Info - All information REQUIRED for consideration of pull request
Jandlyn Bentley, NASA-GSFC

@astrogeco astrogeco changed the title Fix #114 Add new installation instructions to the readme Fix #114, Add new installation instructions to the readme Jul 22, 2020
README.md Outdated Show resolved Hide resolved
@astrogeco astrogeco changed the base branch from master to main July 29, 2020 15:04
Copy link
Contributor

@skliper skliper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might want to just reference he ground system repo, since any direct link to a file will break if the branch names change?

@astrogeco
Copy link
Contributor

Might want to just reference he ground system repo, since any direct link to a file will break if the branch names change?

I think we can reference the main branch now and fix it in the unlikely event that it changes again. I like giving people the fastest way possible to reach things.

@JandlynBentley-at-NASA JandlynBentley-at-NASA marked this pull request as draft July 29, 2020 18:55
@skliper
Copy link
Contributor

skliper commented Jul 30, 2020

Note the text file goes away with a current pr in the system, link to md file would be better.

@astrogeco
Copy link
Contributor

@JandlynBentley-at-NASA I just merged the PR that swaps the .txt with the .md so you should be able to update the link appropriately

@JandlynBentley-at-NASA
Copy link
Contributor Author

I'll update the link now, and once I'm done squashing the commits I'll revert this from a draft to a regular pull request.

@JandlynBentley-at-NASA JandlynBentley-at-NASA force-pushed the fix114-adding-installation-instructions-to-readme branch from 620c906 to b0bf1bc Compare July 30, 2020 21:09
The following additions were made to improve novice user installation experience.

Added a brief introductory statement describing cFS to the top of the page.
Added prerequisite software (make, cmake, gcc, and git) instruction to the Setup section.
Added statement about a possible third dependency (libcanberra-gtk-module) to the Send commands recieve telemetry section.

Additionally, some typos were corrected.

Resolves: nasa#114
@JandlynBentley-at-NASA JandlynBentley-at-NASA force-pushed the fix114-adding-installation-instructions-to-readme branch from b0bf1bc to 830ad24 Compare July 30, 2020 21:15
@JandlynBentley-at-NASA JandlynBentley-at-NASA marked this pull request as ready for review July 30, 2020 21:16
@astrogeco astrogeco merged commit 3979c74 into nasa:main Jul 30, 2020
chillfig pushed a commit to chillfig/cFS that referenced this pull request Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add new installation instructions to the README.md
3 participants