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

New readme #2807

Merged
merged 3 commits into from Apr 9, 2015
Merged

New readme #2807

merged 3 commits into from Apr 9, 2015

Conversation

chrisseaton
Copy link
Contributor

I thought I could make some positive changes to the readme:

  • Talk about it being a JVM implementation rather than a Java implementation
  • Building instructions are all available in BUILDING.md so just point people there
  • Provide instructions on how to install without building from source
  • Warn people against using old versions from their package manager
  • Add some positive statements about what we are trying to achieve
  • Remove some dead links

What do people think?

@cheald
Copy link
Contributor

cheald commented Apr 6, 2015

First off: It's strangely hilarious to me that this failed the CI build :)

That said, I like the direction. I might almost go a step further and go out of the way to highlight some of the reasons that you might want to use JRuby over MRI, rather than just casually mentioning them in the "about" section. The README is what people see when they first encounter the project, so it should really be half information, half marketing copy, IMHO.

I would also include information on bug reporting procedures, pull request protocol, and maybe even a link to the mailing list and IRC channel. If someone has a problem with it, they shouldn't need to go further than the README to figure out how to get additional help.

@chrisseaton
Copy link
Contributor Author

Yeah, introducing some form of marketing copy was my goal. I think the current version isn't confident enough, if you see what I mean.

@kares
Copy link
Member

kares commented Apr 7, 2015

👍 maybe mention the concurrency model (gil-free) in some light form
... as newcomers still ask about how does it differ from MRI

@donv
Copy link
Member

donv commented Apr 7, 2015

👍

@chrisseaton chrisseaton merged commit c8a94e6 into master Apr 9, 2015
@chrisseaton chrisseaton added this to the JRuby 9.0.0.0.rc1 milestone May 4, 2015
@headius
Copy link
Member

headius commented May 4, 2015

This was in pre2 bundle, so marking for pre2.

@headius headius deleted the new-readme branch December 15, 2016 20:22
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.

None yet

6 participants