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

Walkthrough to use this repository #361

Open
Kofituo opened this issue Apr 17, 2023 · 2 comments
Open

Walkthrough to use this repository #361

Kofituo opened this issue Apr 17, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@Kofituo
Copy link

Kofituo commented Apr 17, 2023

Is there a documentation or a walkthrough that shows how to use this repository?
None of the links in this section of the README work. Also, there isn't any documentation for a vast majority of the structs and methods used here.
It'd be nice to know how to use this repo!

@MavenRain
Copy link
Contributor

@Kofituo The goal of the README is to get to the point of being able to do transactions like sending tokens and such. The order of objectives should be as follows:

  1. Get bazel working (although I believe using cargo should also still work)
  2. Start a ledger cluster
  3. Test commands like checking status, balances, and sending tokens.

I can look specifically into why those links aren't working in the README. Let me know where in the three objectives you are getting stuck and I can try to help.

@fmorency
Copy link
Contributor

fmorency commented Apr 20, 2023

Links are not working because we're not publishing to crates.io and docs.rs yet.

Publishing to crates.io is planned for the next release.

Edit: @Kofituo, thanks a lot for your interest and feedback! This is very helpful.

@fmorency fmorency added documentation Improvements or additions to documentation question Further information is requested labels Apr 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants