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

Apply readme generator #276

Merged
merged 8 commits into from
Apr 27, 2020
Merged

Apply readme generator #276

merged 8 commits into from
Apr 27, 2020

Conversation

Darkren
Copy link
Contributor

@Darkren Darkren commented Mar 29, 2020

Did you run make format && make check?
Yes
Fixes #244

Changes:

  • README.md files were generated for visor, setup node and hypervisor configs
  • Added make generate command to generate mocks and config readme files (requires readmegen to be installed with go install

How to test this PR:

  1. Install readmegen with go install from services
  2. Run make generate

Copy link
Contributor

@evanlinjin evanlinjin left a comment

Choose a reason for hiding this comment

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

Looks good. Now we need to add the actual documentation.

Copy link
Contributor

@nkryuchkov nkryuchkov 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!

pkg/app/appnet/mock_networker.go Outdated Show resolved Hide resolved
pkg/app/appserver/mock_proc_manager.go Outdated Show resolved Hide resolved
pkg/app/mock_rpc_client.go Outdated Show resolved Hide resolved
pkg/router/mock_router.go Outdated Show resolved Hide resolved
pkg/hypervisor/README.md Outdated Show resolved Hide resolved
@jdknives jdknives merged commit d1567c8 into skycoin:develop Apr 27, 2020
jdknives added a commit that referenced this pull request Oct 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants