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

Clean up README #1273

Merged
merged 1 commit into from
Apr 18, 2020
Merged

Clean up README #1273

merged 1 commit into from
Apr 18, 2020

Conversation

danobi
Copy link
Member

@danobi danobi commented Apr 16, 2020

Smaller READMEs are nicer for learning about a new project.

This commit:

  • Removes mini language reference. This was getting outdated and we the
    reference guide is our source of truth anyways.
  • Removes examples. We have plenty of examples in the one-liners and
    tools section.
  • Remove internals graphic. This was outdated. It's also present in the
    internal development doc.

@fbs
Copy link
Contributor

fbs commented Apr 16, 2020

Maybe place the oneliners before the install section? That way they're first thing you see.

Smaller READMEs are nicer for learning about a new project.

This commit:
* Removes mini language reference. This was getting outdated and we the
  reference guide is our source of truth anyways.
* Removes examples. We have plenty of examples in the one-liners and
  tools section.
* Remove internals graphic. This was outdated. It's also present in the
  internal development doc.
@danobi danobi merged commit e3c07eb into bpftrace:master Apr 18, 2020
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.

2 participants