Simple README update for Clojure newbies like me : ) #45

Closed
wants to merge 2 commits into
from

3 participants

@bitops

I just added a little extra information to the README file showing which dependency to add to your project.clj file to get started.

@bitops

My first commit was just pulling in the jetty adapter, I genericized it to pull in everything.

@weavejester
Collaborator

You've misunderstood the README a little, although that in itself is an indication it could be improved!

The README is saying that you should run lein deps inside the Ring repository in order to run the examples included.

Also, rather than saying ;; or latest version we should include the latest version in the README, which is currently 1.0.0-RC5. Version 0.3.11 is nearly five months old, so its not a great example to provide.

The README definitely needs to be overhauled, but it'll require a more radical restructuring than this change.

@technomancy

For what it's worth, explicitly running lein deps is usually not required; Leiningen will notice that lib is empty and run deps for you if needed. Maybe instead of invoking java -cp ... directly you could switch to lein run -m example.hello-world, though that would require moving things into a -main function.

@bitops

Hi all, thanks for your comments. I agree that I probably misunderstood the README file. I'll close out this pull request.

I really do appreciate the feedback - it gives me the courage to submit more (hopefully constructive) pull requests.

@bitops bitops closed this Dec 6, 2011
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment