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

Consolidate readme.md and index.md #1915

Merged
merged 10 commits into from
Sep 20, 2017

Conversation

kailuowang
Copy link
Contributor

fix #1896
Right the two documents are highly duplicated. Using a sbt-microsite setting, we can use the same document both as the github readme and the index of the site.
After the consolidation, the readme file was a bit too long, so I extract the motivations section to a separate page.

@codecov-io
Copy link

codecov-io commented Sep 15, 2017

Codecov Report

Merging #1915 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1915   +/-   ##
=======================================
  Coverage   95.54%   95.54%           
=======================================
  Files         248      248           
  Lines        4420     4420           
  Branches      121      124    +3     
=======================================
  Hits         4223     4223           
  Misses        197      197

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7c74048...d1daa3a. Read the comment docs.

Copy link
Contributor

@ceedubs ceedubs left a comment

Choose a reason for hiding this comment

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

Nice. Thanks @kailuowang!

@kailuowang
Copy link
Contributor Author

since this is a documentation only and straightforward change I am going to merge with one maintainer sign-off and one contributor sign-off.

@kailuowang kailuowang merged commit 464be03 into typelevel:master Sep 20, 2017
@kailuowang kailuowang deleted the consolidate-readme-index branch September 20, 2017 15:09
@kailuowang kailuowang added this to the 1.0.0-RC1 milestone Oct 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consolidate readme and index.md
4 participants