[Jython-checkins] jython: Committed #114 'Add README.md'

[stefan.richthofer]

https://hg.python.org/jython/rev/231ce47330a9
changeset:   8202:231ce47330a9
user:        James Mudd <james.mudd at gmail.com>
date:        Tue Dec 04 17:53:19 2018 +0100
summary:
  Committed #114 'Add README.md'

files:
  README.md |  20 ++++++++++++++++++++
  1 files changed, 20 insertions(+), 0 deletions(-)


diff --git a/README.md b/README.md
new file mode 100644
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Jython: Python for the Java Platform
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.python/jython-standalone/badge.svg)](https://search.maven.org/artifact/org.python/jython-standalone/) [![Javadocs](https://www.javadoc.io/badge/org.python/jython-standalone.svg)](https://www.javadoc.io/doc/org.python/jython-standalone)
+
+This is the development repository of Jython. Along with language and runtime compatibility with CPython 2.7, Jython 2.7 provides substantial support of the Python ecosystem. This includes built-in support of *pip/setuptools* (you can use with `bin/pip`) and a native launcher for Windows (`bin/jython.exe`), with the implication that you can finally install Jython scripts on Windows.
+
+**Note that if you have `JYTHON_HOME` set, you should unset it to avoid problems with the installer and pip/setuptools.**
+
+Jim Baker presented a talk at PyCon 2015 about Jython 2.7, including demos of new features: https://www.youtube.com/watch?v=hLm3garVQFo
+
+The release was compiled on OSX using JDK 7 and requires a minimum of Java 7 to run.
+
+Please try this release out and report any bugs at http://bugs.jython.org
+
+You can test your installation of Jython (not the standalone jar) by running the regression tests, with the command:
+```
+jython -m test.regrtest -e -m regrtest_memo.txt
+```
+For Windows, there is a simple script to do this: `jython_regrtest.bat`. In either case, the memo file `regrtest_memo.txt` will be useful in the bug report if you see test failures. The regression tests can take about half an hour.
+
+See [ACKNOWLEDGMENTS](ACKNOWLEDGMENTS) for details about Jython's copyright, license, contributors, and mailing lists; and [NEWS](NEWS) for detailed release notes, including bugs fixed, backwards breaking changes, and new features. We sincerely thank all who contribute to Jython, including - but not limited to - bug reports, patches, pull requests, documentation changes, support emails, and fantastic conversation on Freenode at #jython. Join us there for your questions and answers!

-- 
Repository URL: https://hg.python.org/jython