chore: enhance readme with installation steps and example usage

xixiaofinland / afmt

Salesforce Apex code formatter written in Rust

20 stars 3 forks source link

Closed Damecek closed 2 weeks ago

Damecek commented 2 weeks ago

Add steps to download and build this project together with its dependencies. Also include few of basic usage examples.

xixiaofinland commented 2 weeks ago

Thanks @Damecek for the help!

I don't expect ppl to try this out yet. I aim to have a test version after 2-3months, still have a lot of things to shape up before it's usable.

I will put the to-do list in README and record the progress.

ognjen-vuceljic commented 2 weeks ago

@xixiaofinland @Damecek

If there is any sort of test version available, I'd like to help with trying it out (pseudo QA 😄) - let me know if there's anything I can help with!

Thanks, and looking forward to this one!

xixiaofinland commented 2 weeks ago

I added a progress section in the readme, to let ppl know where it is at the moment. As you can see, there are quite a bit of work to be done.

Nonetheless, I will definitely announce out and ping you when the time comes. @ognjen-vuceljic