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

add readme to libraries and programs #1534

Merged
merged 8 commits into from Jan 25, 2019

Conversation

Projects
3 participants
Show resolved Hide resolved libraries/README.md Outdated
Show resolved Hide resolved libraries/README.md Outdated
Show resolved Hide resolved libraries/README.md Outdated
Show resolved Hide resolved 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`

This comment has been minimized.

Copy link
@pmconrad

pmconrad Jan 22, 2019

Contributor

cat-parts is used to create hardfork.hpp from individual files.
member_enumerator and check_reflect.py are unused AFAICS. Maybe remove them?

This comment has been minimized.

Copy link
@abitmore

abitmore Jan 22, 2019

Member

Please read cryptonomex/graphene#562 for why check_reflect.py is there.

This comment has been minimized.

Copy link
@pmconrad

pmconrad Jan 23, 2019

Contributor

Oh, cool. Didn't know that. Maybe we should integrate this into travis/docker?

Show resolved Hide resolved programs/README.md Outdated
Show resolved Hide resolved libraries/README.md Outdated
Show resolved Hide resolved programs/README.md Outdated
@pmconrad

This comment has been minimized.

Copy link
Contributor

commented Jan 22, 2019

@cedar-book got some hints how to write good documentation? ;-)

oxarbitrage added some commits Jan 22, 2019

Show resolved Hide resolved libraries/README.md Outdated
Show resolved Hide resolved libraries/README.md Outdated
@pmconrad
Copy link
Contributor

left a comment

Good, thanks!

@oxarbitrage

This comment has been minimized.

Copy link
Member Author

commented Jan 25, 2019

@abitmore what do you think ?

@abitmore abitmore added this to the 201902 - Feature Release milestone Jan 25, 2019

@abitmore abitmore added this to In progress in Feature Release (201902) via automation Jan 25, 2019

@abitmore

This comment has been minimized.

Copy link
Member

commented Jan 25, 2019

Very good.
I think cat-parts is actually active since it's used when building.
This is a documentation change, so actually we can merge it to release branch then merge to master and merge back to develop, then it can be seen in master earlier.

Feature Release (201902) automation moved this from In progress to In Review Jan 25, 2019

@abitmore
Copy link
Member

left a comment

Although it makes sense to merge to release (then develop and master), it's also OK for me to merge to develop (then later release then master).

@oxarbitrage oxarbitrage merged commit 0dff411 into bitshares:develop Jan 25, 2019

0 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build could not complete due to an error
Details
ci/dockercloud Your tests are pending in Docker Cloud
Details

Feature Release (201902) automation moved this from In Review to Done Jan 25, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.