search

softwaremill / scala-clippy

Good advice for Scala compiler errors
Apache License 2.0
312 stars 20 forks source link

Short README, full docs on the website. #52

Closed kciesielski closed 7 years ago

kciesielski commented 7 years ago

Current compiler output examples are:

  1. incorrectly encoded as ```scala which adds weird colors
  2. a bit outdated (link to Akka docs is for experimental)
  3. not reflecting full power of awesome colors :)

This PR adds examples as images to address all that.

adamw commented 7 years ago

What about the main page? Or maybe it would be possible to merge these two and show the readme on the web page or vice versa?

kciesielski commented 7 years ago

Good idea, I'll add this there.

kciesielski commented 7 years ago

I think many GH projects have very short README just pointing to the rich doc site if there's one. I'd go with adding all the details to the main page and leave only a short description in README + link, wdyt?

adamw commented 7 years ago

@kciesielski sounds good :)

adamw commented 7 years ago

Deployed :)