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.

Sign up for GitHub

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

Jump to bottom

Improve Getting Started in the docs #22

Open
voddan opened this issue Oct 11, 2018 · 1 comment
Open

Improve Getting Started in the docs #22

voddan opened this issue Oct 11, 2018 · 1 comment
Assignees
@voddan
Labels
documentation

Comments

@voddan
Copy link
Contributor

voddan commented Oct 11, 2018 •
edited
Loading

Now instructions for starting using Cordentity are just gradle clean buil. Please make a usable guide!
@voddan voddan self-assigned this Oct 11, 2018
@osesov
Copy link

osesov commented Oct 11, 2018

Getting Started section should be written with a newbie in mind, and should describe at least two things:

  1. How to run the tests and examples and verify if they work
  2. References to code, which could be used as example of various indy+corda operations. That is the code to copy-and-paste into your project. Few words along with references to ReadmeExampleTest.kt and CordentityE2E.kt should be enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@voddan voddan

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@osesov @voddan