Skip to content

Commit

Permalink
Switch from README.txt to README.md
Browse files Browse the repository at this point in the history
This adds a better markdown based readme for the GitHub repository page.
  • Loading branch information
jamesmudd committed Oct 27, 2018
1 parent 118aa8c commit 7d2fda5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 38 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Jython: Python for the Java Platform

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!
38 changes: 0 additions & 38 deletions README.txt

This file was deleted.

0 comments on commit 7d2fda5

Please sign in to comment.