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

README needs updating #3

Open
rlratzel opened this issue Aug 3, 2021 · 0 comments
Open

README needs updating #3

rlratzel opened this issue Aug 3, 2021 · 0 comments
Assignees
Labels
doc Improvements or additions to documentation improvement Improves an existing functionality

Comments

@rlratzel
Copy link
Contributor

rlratzel commented Aug 3, 2021

The README is in desperate need of updating in order for this repo to be adopted by more projects/users.

It needs the following examples:

  • Basic use by a "project" script that overrides the default config. This was the initial use case, where a project like cuGraph or cuML would, for example, have a MNMG test running script that used the mg-tools scripts to setup the MNMG environment, but had directories, conda env names, etc. specific to their project that overrode the default config before calling the mg-tools scripts.
  • Using the scripts interactively from the CLI

Since the scripts are intended to be a "toolbox", they are meant to be called individually as part of a larger user workflow (these scripts could eventually be packaged as a conda install). Because of that, the README also needs the following documentation:

  • Description of the script hierarchy (in an ASCII tree-like format) which includes every script.
  • Section containing a brief one-line description of what each script does.
@rlratzel rlratzel added doc Improvements or additions to documentation improvement Improves an existing functionality labels Aug 3, 2021
@rlratzel rlratzel self-assigned this Aug 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation improvement Improves an existing functionality
Projects
None yet
Development

No branches or pull requests

1 participant