From 786f0d37aab411fc49156150ad9ab6e0b9448b7f Mon Sep 17 00:00:00 2001 From: Alexandre Archambault Date: Fri, 27 Nov 2015 01:32:52 +0100 Subject: [PATCH] Update README --- README.md | 47 ++++++++++++++++++++++++++++++++++------------- 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 381a7001d..e1ee6debe 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ It handles fancy Maven features like * [dependency management](http://books.sonatype.com/mvnex-book/reference/optimizing-sect-dependencies.html), * [import scope](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Importing_Dependencies), * [properties](http://books.sonatype.com/mvnref-book/reference/resource-filtering-sect-properties.html), -* etc., +* etc. + It happily resolves dependencies involving modules from the Hadoop ecosystem (Spark, Flink, etc.), that make a heavy use of these. @@ -64,31 +65,41 @@ For example, it can launch: $ ./coursier launch com.lihaoyi:ammonite-repl_2.11.7:0.5.0 ``` -* the REPLs of various JVM languages like -** Frege, +along with the REPLs of various JVM languages like + +* Frege, ``` -$ ./coursier launch -r central -r https://oss.sonatype.org/content/groups/public org.frege-lang:frege-repl-core:1.3 -M frege.repl.FregeRepl +$ ./coursier launch -r central -r https://oss.sonatype.org/content/groups/public \ + org.frege-lang:frege-repl-core:1.3 -M frege.repl.FregeRepl ``` -** clojure, + +* clojure, ``` $ ./coursier launch org.clojure:clojure:1.7.0 -M clojure.main ``` -** jruby, + +* jruby, ``` $ wget https://raw.githubusercontent.com/jruby/jruby/master/bin/jirb && \ ./coursier launch org.jruby:jruby:9.0.4.0 -M org.jruby.Main -- -- jirb ``` -** jython, + +* jython, ``` $ ./coursier launch org.python:jython-standalone:2.7.0 -M org.python.util.jython ``` -** Groovy, + +* Groovy, ``` -$ ./coursier launch org.codehaus.groovy:groovy-groovysh:2.4.5 -M org.codehaus.groovy.tools.shell.Main commons-cli:commons-cli:1.3.1 +$ ./coursier launch org.codehaus.groovy:groovy-groovysh:2.4.5 -M org.codehaus.groovy.tools.shell.Main \ + commons-cli:commons-cli:1.3.1 ``` + etc. -* various programs, like Proguard, or its utility, Retrace, +and various programs, like + +* Proguard and its utility Retrace, ``` $ ./coursier launch net.sf.proguard:proguard-base:5.2.1 -M proguard.ProGuard $ ./coursier launch net.sf.proguard:proguard-retrace:5.2.1 -M proguard.retrace.ReTrace @@ -103,6 +114,10 @@ Example ``` $ ./coursier fetch org.apache.spark:spark-sql_2.11:1.5.2 ... +/path/to/.coursier/cache/0.1.0-SNAPSHOT-2f5e731/files/central/io/dropwizard/metrics/metrics-jvm/3.1.2/metrics-jvm-3.1.2.jar +/path/to/.coursier/cache/0.1.0-SNAPSHOT-2f5e731/files/central/javax/servlet/javax.servlet-api/3.0.1/javax.servlet-api-3.0.1.jar +/path/to/.coursier/cache/0.1.0-SNAPSHOT-2f5e731/files/central/javax/inject/javax.inject/1/javax.inject-1.jar +... ``` ### classpath @@ -120,8 +135,9 @@ Welcome to the Ammonite Repl 0.5.0 ## API -This @larsrh [gist](ammonite.repl.Repl) illustrates how the API of coursier can be used to get transitives dependencies -and fetch the corresponding artefacts +This [gist](ammonite.repl.Repl) by [Lars Hupel](https://github.com/larsrh/) +illustrates how the API of coursier can be used to get transitives dependencies +and fetch the corresponding artefacts. More explanations to come :-) @@ -140,13 +156,18 @@ updated for now. [#41](https://github.com/alexarchambault/coursier/issues/41) - SBT plugin [#52](https://github.com/alexarchambault/coursier/issues/52), requires Ivy-like configurations [#8](https://github.com/alexarchambault/coursier/issues/8) +See the list of [issues](https://github.com/alexarchambault/coursier/issues). + # Contributors - Your name here :-) +Don't hesitate to pick an issue to contribute, and / or ask for help for how to proceed +on the [Gitter channel](https://gitter.im/alexarchambault/coursier). + # Projects using coursier -- @larsrh's [libisabelle](https://github.com/larsrh/libisabelle) fetches +- [Lars Hupel](https://github.com/larsrh/)'s [libisabelle](https://github.com/larsrh/libisabelle) fetches some of its requirements via coursier, - [jupyter-scala](https://github.com/alexarchambault/jupyter-scala) should soon allow to add dependencies in its sessions with coursier (initial motivation for writing coursier),