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

Clarify the installation and building of the example apps in a pre-made system #9

Open
colinam1 opened this issue Jul 26, 2019 · 2 comments
Assignees

Comments

@colinam1
Copy link

colinam1 commented Jul 26, 2019

Please specify where and what exactly to run the shell scripts contained with ECI for cFS 6.6. Specifically to get it to work in nos3. A step-by-step guide on how to install and an ECI example app would be very useful, mentioning specifically what directories different files have to be located and run in.

For example like this under the setup and build and run secions of cFS on github, located here https://github.com/nasa/cFS

@SpaceSteve121
Copy link
Contributor

SpaceSteve121 commented Jul 29, 2019

Having never used it, I can't comment on NOS3 or advise on how to integrate software into it. Perhaps open an issue on their repo if you need further instructions?

I can try to help for working with a general CFS system though.

We've implemented a CI pipeline on the 6.6 branch which you should be able to use as a guide, while we get the documentation updated for 6.6. If you look at travis.yml on that branch, you'll see the commands needed to build the SGP4 example app are

cmake ./ci/sgp4
make -C ./cfs

from the root of the ECI repo. Those commands will create you a working CFS directory structure from scratch by cloning several repos that you'll need and will integrate ECI and the SGP4 app into that CFS tree that it creates. Hopefully that should help demonstrate what the end goal is. You can look at specifically what's happening during that process by examining the definition of the sgp4 config and the cmake functions that are doing the work in setup.cmake.

I agree that better documentation is needed and am working on converting the integration guide to markup and making it more beginner-friendly (it previously assumed alot of CFS knowledge).

Just a note, those scripts are useful for getting started but not necessarily what you'll want to use once you have your project established (because you'll probably want more control over what version of each repo you're using).

@SpaceSteve121
Copy link
Contributor

Also note that the commands to build the CFS system don't necessarily change by integrating new apps, other than perhaps specifying a different cmake config if you call yours something other than the default, so I don't expect we'll be adding any documentation on how to build CFS.

Let me know if this makes sense and/or if you have additional questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants