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

simple start for the README #632

Merged
merged 3 commits into from
Dec 13, 2024
Merged

simple start for the README #632

merged 3 commits into from
Dec 13, 2024

Conversation

yegor256
Copy link
Member

see #631

@yegor256 yegor256 requested a review from fizruk December 12, 2024 11:40
@yegor256
Copy link
Member Author

@fizruk please, take a look

@fizruk fizruk requested a review from deemp December 13, 2024 07:21
@deemp
Copy link
Member

deemp commented Dec 13, 2024

@yegor256 @fizruk, this initial version of README is OK.

However, I think the output of all commands should be provided in the README. Ideally, the output should be generated automatically via a tool like mdsh.

Automating the README updates can be done in another PR.

@yegor256
Copy link
Member Author

@deemp I suggest keeping README as simple as possible, making it play the role of a motivator not a reference manual. The user should be able to understand how to do a few basic operations and get the results that the user expects. When additional information will be required, the user may go to another place (the website, for example). However, this will happen rarely, I believe (taking into account the fact that there are just a few users and all of them are in our team).

@fizruk fizruk merged commit 54d4e49 into master Dec 13, 2024
9 checks passed
@fizruk fizruk deleted the 631 branch December 13, 2024 08:49
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.

3 participants