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

Split `README.md` into smaller files #12272

Open
0fiscalentropy opened this issue Feb 26, 2017 · 4 comments
Open

Split `README.md` into smaller files #12272

0fiscalentropy opened this issue Feb 26, 2017 · 4 comments

Comments

@0fiscalentropy
Copy link
Contributor

@0fiscalentropy 0fiscalentropy commented Feb 26, 2017

The README.md is really long. Considering that it loads every time someone goes to the main page, wouldn't it be better to keep some of it (e.g., the FAQ) in separate files?

@yan12125
Copy link
Collaborator

@yan12125 yan12125 commented Feb 26, 2017

Currently everything is in the same file as it's easier to generate the man page.

@fireattack
Copy link

@fireattack fireattack commented Feb 26, 2017

I feel it's actually easier to search through if they're all on the same page. Just my personal opinion.

@dheepakg
Copy link

@dheepakg dheepakg commented Nov 15, 2019

Are we going to split the ReadMe or leaving it as it is?

@anantdark
Copy link

@anantdark anantdark commented Oct 12, 2020

I am available to contribute if you decide on spliting the README.

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

Successfully merging a pull request may close this issue.

None yet
5 participants
You can’t perform that action at this time.