Update our README
mlangc opened this issue · 13 comments
Our README is currently out of date and not very contributor friendly. It should mention
- that most refactoring are currently unmaintained and are waiting for contributors
- that we use SBT and not Maven
- some tips for new contributors
👍 it might even be a good idea to make scala-refactoring.org just redirect to the github page. False information is worse than no information (and let's be honest, this is not the kind of project that ever expects to have hundreds of contributors... it'll be the kind of place that scala-ide / ensime core developers will guide contributors towards)
I think that scala-refactoring.org is maintained by @misto, so we should probably involve him in the discussion...
Just redirecting sounds good to me, I'll make the changes.
All right, but I think we should keep your master thesis around somewhere.. it's very useful for understanding the library!
@misto can you perhaps push the current website to a gh-pages branch on this repo? That's the standard convention.
That won't be so easy since it's based on Wordpress, but most of the information is outdated anyway. But we could just create a new GitHub page and upload the thesis there.
I've just started working on this (unfortunately I cannot assign the issue to myself since I don't have the necessary privileges).
@fommil I've just created a PR; if you happen to have some time to spare, it would be great if you could skim over this, telling me if
- if this is understandable to outsiders
- where my English could use some improvements
Now that we have the new Readme, what about just redirecting scala-refactoring.org to this repository?
I'm ok with that.
This sounds like a good idea... let's close this issue as soon as this is implemented.
README is updated. The only thing that is missing is that scala-refactoring.org redirects to Github
Done!