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.

Sign up for GitHub

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

Jump to bottom

Add new installation instructions to the README.md #114

Closed
JandlynBentley-at-NASA opened this issue Jul 17, 2020 · 0 comments · Fixed by #115
Closed

Add new installation instructions to the README.md #114

JandlynBentley-at-NASA opened this issue Jul 17, 2020 · 0 comments · Fixed by #115
Assignees
@JandlynBentley-at-NASA
Labels
docs enhancement

Comments

@JandlynBentley-at-NASA
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Several user experience improvements can be made to the general cFS README.md to help brand new cFS users (like interns who've never encountered cFS before) through the installation process.

Describe the solution you'd like

  1. Add in a brief introductory statement at the very top explaining what cFS is.
  2. Under the "Setup and Build and Run" sections add a list of prerequisite software that should be preinstalled before cloning cFS (i.e. make, cmake, gcc, and git).
  3. Under the "Send commands, receive telemetry section" add in the specific installation commands for pyqt5, zmq, and libcanberra-gtk-module from the ground system's readme (I and some of my fellow interns ran into issues with installation because cFS was very picky in how these three were installed).

Requester Info
Submitted by: Jandlyn Bentley, NASA-GSFC
JandlynBentley-at-NASA pushed a commit to JandlynBentley-at-NASA/cFS that referenced this issue Jul 21, 2020
Fix nasa#114 Add new installation instructions to the readme
5df0083 
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 specific installation instructions for pyqt5, pyzmq, and libcanberra-gtk-module to the Send commands recieve telemetry section.

Additionally, some typos were corrected.

Resolves: nasa#114
Merged
JandlynBentley-at-NASA pushed a commit to JandlynBentley-at-NASA/cFS that referenced this issue Jul 23, 2020
Fix 114 - adding installation clarifications to the README
df1e3eb 
In this commit, better changes were made to the ground system installation instructions for pyqt5, pyzmq, and libcanberra-gtk-module under the Send commands receive telemetry section.

Resolves: nasa#114
JandlynBentley-at-NASA pushed a commit to JandlynBentley-at-NASA/cFS that referenced this issue Jul 29, 2020
Fix nasa#114 adding installation clarifications aimed at novice users…
620c906 
… in the readme

In this commit, markdown syntax was used to clean up the link for the Guide-GroundSystem.txt

Resolves: nasa#114
JandlynBentley-at-NASA pushed a commit to JandlynBentley-at-NASA/cFS that referenced this issue Jul 30, 2020
Fix nasa#114 Add new installation instructions to the readme
902781b 
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 specific installation instructions for pyqt5, pyzmq, and libcanberra-gtk-module to the Send commands recieve telemetry section.

Additionally, some typos were corrected.

Resolves: nasa#114

Fix 114 - adding installation clarifications to the README

In this commit, better changes were made to the ground system installation instructions for pyqt5, pyzmq, and libcanberra-gtk-module under the Send commands receive telemetry section.

Resolves: nasa#114
JandlynBentley-at-NASA pushed a commit to JandlynBentley-at-NASA/cFS that referenced this issue Jul 30, 2020
Fix nasa#114 adding installation clarifications aimed at novice users…
157744d 
… in the readme

In this commit, markdown syntax was used to clean up the link for the Guide-GroundSystem.txt

Resolves: nasa#114
JandlynBentley-at-NASA pushed a commit to JandlynBentley-at-NASA/cFS that referenced this issue Jul 30, 2020
Fix nasa#114 add new installation instruction to the readme
b0bf1bc 
The following additions were made to improve novice user installation experience in the cFS README.md

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 for the GroundSystem (libcanberra-gtk-module) under the Send commands receive telemetry section
Reworded the redirection to the Guide-GroundSystem.md for questions regarding setup and installation

Additionally, some typos were corrected.

Resolves nasa#114
JandlynBentley-at-NASA pushed a commit to JandlynBentley-at-NASA/cFS that referenced this issue Jul 30, 2020
Fix nasa#114 Add new installation instructions to the readme
830ad24 
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
astrogeco added a commit that referenced this issue Jul 30, 2020
@astrogeco
Merge pull request #115 from JandlynBentley-at-NASA/fix114-adding-ins…
3979c74 
…tallation-instructions-to-readme

Fix #114, Add new installation instructions to the readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JandlynBentley-at-NASA JandlynBentley-at-NASA

Labels
docs enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix #114, Add new installation instructions to the readme JandlynBentley-at-NASA/cFS
1 participant
@JandlynBentley-at-NASA