add readme to libraries and programs #1534
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pmconrad
reviewed
Jan 20, 2019
pmconrad
reviewed
Jan 20, 2019
pmconrad
reviewed
Jan 20, 2019
pmconrad
reviewed
Jan 22, 2019
pmconrad
reviewed
Jan 22, 2019
programs/README.md
Outdated
| [js_operation_serializer](js_operation_serializer) | Operation Serializer | Dump all blockchain operations and types. Used by the UI. | Tool | Old | `./js_operation_serializer` | ||
| [size_checker](size_checker) | Size Checker | Provides wire size average in bytes of all the operations | Tool | Old | `./size_checker` | ||
| [build_helpers](build_helpers) | Build Helpers | | Tool | Old | `./member_enumerator` and `./cat-parts` |
There was a problem hiding this comment.
cat-parts is used to create hardfork.hpp from individual files.
member_enumerator and check_reflect.py are unused AFAICS. Maybe remove them?
There was a problem hiding this comment.
Please read cryptonomex/graphene#562 for why check_reflect.py is there.
There was a problem hiding this comment.
Oh, cool. Didn't know that. Maybe we should integrate this into travis/docker?
pmconrad
reviewed
Jan 22, 2019
pmconrad
reviewed
Jan 22, 2019
pmconrad
reviewed
Jan 22, 2019
|
@cedar-book got some hints how to write good documentation? ;-) |
pmconrad
reviewed
Jan 23, 2019
pmconrad
reviewed
Jan 23, 2019
|
@abitmore what do you think ? |
|
Very good. |
abitmore
approved these changes
Jan 25, 2019
17 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For #1532
Looking for some help to improve it.
Here is how the files are looking:
https://github.com/bitshares/bitshares-core/blob/41bff6ead331c4f340e874c5c9102d23deb487be/libraries/README.md
https://github.com/bitshares/bitshares-core/blob/41bff6ead331c4f340e874c5c9102d23deb487be/programs/README.md