leptos-rs / cargo-leptos

Build tool for Leptos (Rust)
MIT License
368 stars 106 forks source link

Expand documtentation on new setup (README.md + inside --help command) #356

Open luckynumberke7in opened 3 months ago

luckynumberke7in commented 3 months ago

I have used cargo-leptos since somewhere around leptos 0.4 on and off to play around and learn both Rust & Leptos.

In my time making new projects (probably around 10 to 20 spread out over that time) I have gone through the process of forgetting how exactly to use cargo-leptos to generate a project based on a github example that is not one of the 3 starter templates.

It would be REALLY nice to have some more examples of specific different use cases involving cargo leptos new -g <web addr> as well as a --git example etc. right under the Usage: bit inside of --help command as well as more examples in the README.md inside cargo-leptos gh repo.

I'm more than willing to dig through this repo and attempt to give it a more beginner friendly facelift...but I still need a bit of clarity on how to achieve the above mentioned solutions before I can do so.

As always, thanks for all the hard work that's gone into these projects =]

luckynumberke7in commented 3 months ago

There is also no mention of -g or --git anywhere inside the --help command (or even that you can add a modifier to the commands at all actually), which I can also add once I understand!

Edit: "I'm currently reading the discord about this and how everything works. I'll check back in soon when I get it with a pr to try and help document this if that is something people are interested in."

Side note (to self mostly): Leptos discord is such a good learning base / reference =P