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

Add a README.md file #12

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

Add a README.md file #12

wants to merge 9 commits into from

Conversation

webchick
Copy link

What was changed

This PR adds a README.md that contains much of the installation instructions written by @steveandroulakis as well as some additional notes that I hit going through.

This still has outstanding TODOs, and I see that the instructions are under active construction, so this may be "won't fix" but figured I'd try and give a stab to get things rolling.

Why?

  • This repo is going to be mentioned during the keynote, and people are gonna be curious. :)
  • This puts the docs in a file where we can easily see change revisions, etc.
  • The folks actively building the demo need to stay focused on that.
  • Writing docs is fun for me. :D

@webchick webchick self-assigned this Sep 12, 2024
@CLAassistant
Copy link

CLAassistant commented Sep 12, 2024

CLA assistant check
All committers have signed the CLA.

@steveandroulakis
Copy link
Collaborator

This is great! Will let @robholland review fully and in light of the fact it's probably a quickly-moving target

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

Successfully merging this pull request may close these issues.

3 participants