docs: update README with `atlas --help`

[OmarIthawi]

This helps engineers to understand the project at a glance ~even though README can be outdated a bit~ while ensuring the section is up to date.

Yes, now atlas --help prints reStructredText (RST) but hopefully it's not too intrusive.

This contribution is part of the FC-0012 project which is sparked by the Translation Infrastructure update OEP-58.

[brian-smith-tcril]

I assume these changes won't be a problem when running it, but I just want to verify you've run gengetoptions https://github.com/openedx/openedx-atlas/blob/47a9eb8d239b2f83b45d9b20b21decceaa13fc73/Makefile#L7-L10

and everything still looks correct

[OmarIthawi]

I assume these changes won't be a problem when running it, but I just want to verify you've run gengetoptions

https://github.com/openedx/openedx-atlas/blob/47a9eb8d239b2f83b45d9b20b21decceaa13fc73/Makefile#L7-L10

and everything still looks correct

Yes @brian-smith-tcril, actually the CI fails everytime that I forget to run gengetoptions. I see a test case for it and it seems to be working properly.

[openedx-webhooks]

Thanks for the pull request, @OmarIthawi! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[OmarIthawi]

@brian-smith-tcril I've updated it to include atlas --help as a code block and removed the rst-hacks from atlas so it should be more terminal-friendly.

The preview for the README is available here: https://github.com/Zeit-Labs/openedx-atlas/blob/[readme-doc](https://github.com/Zeit-Labs/openedx-atlas/blob/readme-docs/README.rst)s/README.rst

[openedx-webhooks]

@OmarIthawi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

[github-actions[bot]]

:tada: This PR is included in version 0.3.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: