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

Create README for this repo. #10

Open
demitri opened this issue May 16, 2020 · 1 comment
Open

Create README for this repo. #10

demitri opened this issue May 16, 2020 · 1 comment

Comments

@demitri
Copy link
Contributor

demitri commented May 16, 2020

I'd like to request a detailed README be written for this repo. This is a great project that should be documented and advertised as such, and GitHub READMEs have become the first port of call for these kinds of things. Suggestions for inclusion:

  • features and functionality of AST
  • some history showing how long it's been developed
  • projects/surveys that use AST
  • a note on the funding level compared to its impact
  • directions on installation, specific to the C version here
  • pointers to other versions
  • link to documentation
  • issues to be aware of for people who use the code (see ast.h subject to collision with python's ast.h in some build processes #6)
  • pretty pictures

I'm a big fan of this library and would like to see its visibility increase. Thanks to all for the work on it!

@dsberry
Copy link
Member

dsberry commented May 19, 2020

I'll add this to me do list. It may not happen immediately due to pressure of other work, but I'll get back to it.

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

No branches or pull requests

2 participants