Skip to content

Commit

Permalink
Add Cython parser doc
Browse files Browse the repository at this point in the history
  • Loading branch information
medeor413 authored Apr 25, 2017
1 parent ca5519e commit efcb6f5
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CYTHON_PARSER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Information
The Cython parser is a Cython (C-Python fusion language) module for the StarryPy packer parser.
Since it's compiled, it is significantly faster than the pure Python parser. It is distributed as source
with StarryPy3k and includes a file to compile it quickly. Note that the Cython parser is experimental and
therefore may contain bugs, does not yet do all of the parsing work, and is disabled by default.
## Using the Cython parser
Prerequisites:
- Cython (built against 0.25.2)
- A C compiler

Simply run the following command in StarryPy3k's base directory:

`python build_parser.py build_ext --inplace`

Once the Cython parser has been built (as a `.so` on Linux or a `.pyd` on Windows), it will be used automatically.

0 comments on commit efcb6f5

Please sign in to comment.