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

Updating README to have more background, example usage, and more detailed installation instructions #119

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

maxlindbergh
Copy link

Summary

I've added some project background to make the goals and capabilities of this project more clear to people not familiar with the codebase. Additionally, I've added an "Example Usage" section to the README so that it is, again, more clear to new users how they can use this software.

Finally, I've added a bit of description to each of the three installation options. I've put in some information on how they differ and when each case should be used.

Test plan

This is purely a documentation change so no real testing is required.

@facebook-github-bot
Copy link

Hi @maxlindbergh!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

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

Successfully merging this pull request may close these issues.

2 participants