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

Ideas after first glance about README #574

Open
Xuanwo opened this issue Aug 4, 2023 · 1 comment
Open

Ideas after first glance about README #574

Xuanwo opened this issue Aug 4, 2023 · 1 comment

Comments

@Xuanwo
Copy link

Xuanwo commented Aug 4, 2023

Hi, I'm a new comer of this project. I have ideas about the improvement of README.

ast-grep is a AST-based tool to search code by pattern code.

Cool! But what's AST? What's the different from normal code? And what's the different from grep or even ripgrep? How about show some pictures here? (I only know about grep and nothing about code developement)

You can use $ sign + upper case letters as wildcard, e.g. $MATCH, to match any single AST node. Think it as REGEX dot ., except it is not textual.

Wait, wait, wait. I just learnt about 1+1=2, now I need to prove that P=NP. Too much for me.

There are many new concepts here: $ sign, wildcard, $MATCH, REGEX, ...

How about show some quick and simple examples here? Or move this part later.

Demo

Demo is too long. And I don't know what you are doing. (I'm a stupid guy)

CLI Screenshot

This section is really great! Why not put this in the first of README? I'm nearly going to leave this page. (Now, I'm an impatient guy)

@HerringtonDarkholme
Copy link
Member

HerringtonDarkholme commented Aug 4, 2023

Thanks for the report! I'm going to look at how the readme can be improved!
This is valuable feedback from the community, thanks!

https://github.com/marionebl/svg-term-cli

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