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 building, testing, and testnet instructions on README #38

Merged
merged 4 commits into from
Jun 29, 2022

Conversation

vitsalis
Copy link
Member

@vitsalis vitsalis commented Jun 29, 2022

This PR introduces some simple instructions for performing common operations inside the README.md file. Some of those might be too specific for the final version of the README file and can be moved to more specific files in the future.

@vitsalis vitsalis requested a review from aakoshh June 29, 2022 12:22
@vitsalis vitsalis changed the title Add building, testing, and testnet instructions on README Add building, testing, and testnet instructions on README Jun 29, 2022
Copy link
Contributor

@aakoshh aakoshh left a comment

Choose a reason for hiding this comment

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

So useful, thanks a lot! 🏅

My only suggestion is to use console or sh highlighting for the code blocks.

I used to use console with $ because Markdown will color the prompt and the command output nicely. It only coloured in the first > out of >>>.

However, somebody pointed out to me that I shouldn't do this because people will try to copy paste the command and get into trouble with the leading $. The recommendation was to keep the output separately. This seemed annoying, but I just found this style guide that recommends the same thing.

Perhaps console with prompts is best used for showing an example session, with multiple commands. But your commands do look like things that somebody would want to copy to their console to run a testnet, so the >>> or $ can become irritating.

Since you aren't showing the output most of the time, the prompt could be removed at least for those commands, and they can use sh or bash. I reckon the ls example can be with the prompt and the output, because it's more concise than including the output in prose.


## Requirements

- Go 1.17
Copy link
Contributor

Choose a reason for hiding this comment

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

What would it take to move to 1.18?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure exactly, but I figure we should stick to 1.17 since v0.45.4 of the SDK uses it

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't see any apparent issues when changing the first line of go.mod to 1.18 and building though.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@vitsalis
Copy link
Member Author

Thanks @aakoshh for the suggestions and explanation! Addressed the comments, please check.

Copy link
Contributor

@aakoshh aakoshh left a comment

Choose a reason for hiding this comment

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

🎉

@vitsalis vitsalis merged commit 1e935d2 into main Jun 29, 2022
@vitsalis vitsalis deleted the readme-instructions branch June 29, 2022 16:09
KonradStaniec added a commit that referenced this pull request Oct 25, 2023
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.

2 participants