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 "real" README #34

Closed
keimlink opened this issue Jul 20, 2014 · 3 comments
Closed

Add "real" README #34

keimlink opened this issue Jul 20, 2014 · 3 comments

Comments

@keimlink
Copy link
Contributor

The README is currently the first page of the book. But in my opinion it would be better if the README would explain the purpose of the project and how to create, edit and contribute to it.

For example it is not obvious for someone who has no experience with gitbook how to install it and serve the book locally.

@olasitarska
Copy link
Member

Yeah, I think gitbook treats the main README.md file as a first chapter, so I don't know if there is a way to update this README.md without chaning the introduction chapter on gitbook. We will figure it out later this week :)

@miohtama
Copy link
Contributor

Apparently Gitbook does not support overriding README.md.

My suggestion is to add CONTRIBUTING.md which explains

  • Link CONTRIBUTING.md to the bottom of README.md
  • What is this project
  • Who is maintaining it
  • What is the edit workflow (and toolset) if you want to publish fixes to the documentation

@oinopion
Copy link
Contributor

Fixed by #45.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants