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

Added more descriptive Readme file. #2935

Merged
merged 1 commit into from
Nov 15, 2022

Conversation

andprogrammer
Copy link
Contributor

@andprogrammer andprogrammer commented Nov 5, 2022

Describe how Hyperledger Iroha C++ library works. Provide examples. Show how to install and use the current version of the library.
Show how to run examples with transactions, batch and commands.
Benefits:
End user will know what the library is responsible for and how to use it properly.

Copy link
Contributor

@baziorek baziorek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few small comments.


BTW. Could You please add:

#incude <optional>

to files:

  • iroha/iroha-lib/model/generators/CommandGenerator.hpp
  • iroha/iroha-lib/model/generators/QueryGenerator.hpp

because when I was trying to build the library in my compiler it was not compiling (probably I have never g++ than You).

Copy link
Contributor

@baziorek baziorek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks much better.

@andprogrammer andprogrammer temporarily deployed to test-env November 10, 2022 12:32 Inactive
@andprogrammer andprogrammer temporarily deployed to test-env November 10, 2022 12:32 Inactive
@andprogrammer andprogrammer temporarily deployed to test-env November 10, 2022 12:32 Inactive
@andprogrammer andprogrammer temporarily deployed to test-env November 10, 2022 12:32 Inactive
Copy link
Contributor

@outoftardis outoftardis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

readme lgtm

Copy link
Contributor

@baziorek baziorek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job!

Copy link
Contributor

@6r1d 6r1d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@appetrosyan appetrosyan merged commit d93228d into hyperledger-iroha:develop Nov 15, 2022
@nxsaken nxsaken added the iroha1 The legacy version of Iroha. label Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.5 Documentation Documentation changes iroha1 The legacy version of Iroha.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants