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

README rework #335

Merged
merged 5 commits into from
Oct 30, 2018
Merged

README rework #335

merged 5 commits into from
Oct 30, 2018

Conversation

danielmpetrov
Copy link
Contributor

@danielmpetrov danielmpetrov commented Oct 25, 2018

The CoreWiki README was getting bloated with mostly irrelevant to the project information. Newcomers were having difficulties getting started due to lack of relevant documentation and a getting started guide.

Sections removed:

  • Those that were strictly about Jeff's stream, since they were practically duplicated from his LiveStream repo. They were replaced with a short sentence and a link to that repository.
  • The huge list of 'Topics covered in previous streams'. I found that list to be unhelpful, since there were no links or further references, just a big list of topics.
  • Considering for removal: CoreWiki streams index, since Jeff created a youtube playlist. If we decide to keep this index, it should probably reside in another document. The list is currently as a last section to the README.

Sections added:

  • Table of contents
  • Getting started - live demo, development, deployment, and FAQ
  • Features
  • Continuous Integration
  • Streams Archive (pending removal)

Of course, this PR is just groundwork. More content needs to be added, and suggestions and feedback are appreciated! 👐

Resolves #318 (to some degree)

@csharpfritz csharpfritz merged commit 27d4e83 into csharpfritz:dev Oct 30, 2018
@csharpfritz
Copy link
Owner

Thank you for doing this refactoring... it reads a lot better now

@Eldorian
Copy link

Just wanted to give a huge thanks for this - this helped a lot. Especially love the section about local development as that was another place I was stuck on for a bit.

@danielmpetrov danielmpetrov deleted the improve_readme branch October 30, 2018 16:40
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