Skip to content

Commit 6d6702c

Browse files
committed
convert README to README.md markdown
1 parent 8b9cb2d commit 6d6702c

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# clojure-python
1+
clojure-python is a library for Jython interop in Clojure.
22

3-
by Robert P. Levy
3+
Overview
4+
========
45

56
Python libraries can be used in Clojure by instantiating
67
a Jython interpreter via Clojure's excellent Java interop.
@@ -9,24 +10,28 @@ makes interop with Python clumsy and verbose. This library
910
aims to make Jython interop in Clojure nearly as seamless
1011
as basic java interop.
1112

12-
## Usage and Installation
13+
Usage and Installation
14+
======================
1315

1416
To experiment with it:
17+
---------------------
1518

16-
1. clone the repository
17-
2. mvn install:install-file -DgroupId=org.python -DartifactId=jython -Dversion=2.5.1 -Dpackaging=jar -Dfile=./etc/jython-2.5.1.jar
19+
0. clone the repository
20+
0. mvn install:install-file -DgroupId=org.python -DartifactId=jython -Dversion=2.5.1 -Dpackaging=jar -Dfile=./etc/jython-2.5.1.jar
1821
(Because the Maven artifact for Jython 2.5.1 has not yet been added to the central Maven repository, for now it is necessary to install it locally with mvn before running lein deps.)
19-
3. lein deps
20-
4. lein repl
22+
0. lein deps
23+
0. lein repl
2124

2225
To include as a dependency:
26+
--------------------------
2327

2428
Copy the config section found at http://clojars.org/clojure-python into your dependencies in your project's project.clj.
2529

2630
Important: it will be necessary to include step #2 above (mvn install...) and the 2.5.1 jar itself in any installation instructions for using this as a dependency, until a recent version of Jython is made available in the central maven repository.
2731

28-
## License
32+
License
33+
=======
2934

30-
Copyright (C) 2010 Robert P. Levy
35+
Copyright (C) 2010-2012 Robert P. Levy
3136

3237
Distributed under LGPL.

0 commit comments

Comments
 (0)