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

Usage instructions #2

Open
9 tasks
kris-rowe opened this issue May 8, 2023 · 0 comments
Open
9 tasks

Usage instructions #2

kris-rowe opened this issue May 8, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
Docs Refresh: Rou...

Comments

@kris-rowe
Copy link
Collaborator

Provide documentation on how to build and run a libocca application.

Currently the README gives basic details on using the cmake package files and env modules.

Todo

  • Create RUN.md
  • How to build a downstream application
    • Propagation of dependencies
  • How to run a downstream application
    • Table of environment variables with descriptions
  • Kernel caching
  • Debugging/troubleshooting
    • Common issues
    • Best practices
@kris-rowe kris-rowe added the documentation Improvements or additions to documentation label May 8, 2023
@kris-rowe kris-rowe added this to the Docs Refresh: Round 1 milestone May 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Docs Refresh: Round 1
Development

No branches or pull requests
1 participant
@kris-rowe