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

Update flags section in main README.md #13

Open
GregConan opened this issue Nov 17, 2021 · 0 comments
Open

Update flags section in main README.md #13

GregConan opened this issue Nov 17, 2021 · 0 comments
Assignees
@perronea @GregConan
Labels
documentation enhancement New feature or request

Comments

@GregConan
Copy link

GregConan commented Nov 17, 2021 •
edited
Loading

In the main README.md,

  • Describe the flags by adding the output of the abcd2.bids.py --help command (but keep the extra descriptions)
  • Add the abbreviations for the flags
  • Split "Optional Arguments" section into Recommended and Optional
  • List the --steps flag higher up in the main README.md
  • Make the example wrapper call into one paragraph instead of side-scrolling?
@GregConan GregConan added the enhancement New feature or request label Nov 17, 2021
@GregConan GregConan changed the title Update flags in documentation Update flags section in main README.md Nov 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@perronea perronea

@GregConan GregConan

Labels
documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@perronea @GregConan