mirror of https://github.com/lark-parser/lark.git
Moved development instructions from README.md to docs
This commit is contained in:
parent
92b312df8e
commit
3fb0c48557
33
README.md
33
README.md
|
@ -165,38 +165,7 @@ Lark uses the [MIT license](LICENSE).
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
Lark is currently accepting pull-requests.
|
Lark is currently accepting pull-requests. See [How to develop Lark](/docs/how_to_develop.md)
|
||||||
|
|
||||||
There are many ways you can help the project:
|
|
||||||
|
|
||||||
* Help solve issues
|
|
||||||
* Improve the documentation
|
|
||||||
* Write new grammars for Lark's library
|
|
||||||
* Write a blog post introducing Lark to your audience
|
|
||||||
* Port Lark to another language
|
|
||||||
* Help me with code developemnt
|
|
||||||
|
|
||||||
If you're interested in taking one of these on, let me know and I will provide more details and assist you in the process.
|
|
||||||
|
|
||||||
## Unit Tests
|
|
||||||
|
|
||||||
To run all Unit Tests,
|
|
||||||
install tox and Python 2.7 up to the latest python version supported (consult the file tox.ini).
|
|
||||||
Then,
|
|
||||||
run the command `tox` on the root of this project (where the main setup.py file is on).
|
|
||||||
|
|
||||||
If you would like to only run the Unit Tests for Python version 2.7,
|
|
||||||
you can run the command `tox -e py27`
|
|
||||||
|
|
||||||
If you would like to run a single Unit Test,
|
|
||||||
you do not need to use tox,
|
|
||||||
you can directly run it with your current python interpreter.
|
|
||||||
First you need to figure out what is the test full name.
|
|
||||||
For example:
|
|
||||||
```python
|
|
||||||
## test_package.tests_module.test_class_name.test_function_name
|
|
||||||
python -m unittest tests.test_parser.TestLalrStandard.test_lexer_error_recovering
|
|
||||||
```
|
|
||||||
|
|
||||||
## Donate
|
## Donate
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,39 @@
|
||||||
|
# How to develop Lark - Guide
|
||||||
|
|
||||||
|
There are many ways you can help the project:
|
||||||
|
|
||||||
|
* Help solve issues
|
||||||
|
* Improve the documentation
|
||||||
|
* Write new grammars for Lark's library
|
||||||
|
* Write a blog post introducing Lark to your audience
|
||||||
|
* Port Lark to another language
|
||||||
|
* Help me with code developemnt
|
||||||
|
|
||||||
|
If you're interested in taking one of these on, let me know and I will provide more details and assist you in the process.
|
||||||
|
|
||||||
|
|
||||||
|
## Unit Tests
|
||||||
|
|
||||||
|
To run all Unit Tests,
|
||||||
|
install tox and Python 2.7 up to the latest python version supported (consult the file tox.ini).
|
||||||
|
Then,
|
||||||
|
run the command `tox` on the root of this project (where the main setup.py file is on).
|
||||||
|
|
||||||
|
If you would like to only run the Unit Tests for Python version 2.7,
|
||||||
|
you can run the command `tox -e py27`
|
||||||
|
|
||||||
|
If you would like to run a single Unit Test,
|
||||||
|
you do not need to use tox,
|
||||||
|
you can directly run it with your current python interpreter.
|
||||||
|
First you need to figure out what is the test full name.
|
||||||
|
For example:
|
||||||
|
```python
|
||||||
|
## test_package test_class_name.test_function_name
|
||||||
|
python -m tests TestLalrStandard.test_lexer_error_recovering
|
||||||
|
```
|
||||||
|
|
||||||
|
Equivalent example/way, but unrecommended:
|
||||||
|
```python
|
||||||
|
## test_package.tests_module.test_class_name.test_function_name
|
||||||
|
python -m unittest tests.test_parser.TestLalrStandard.test_lexer_error_recovering
|
||||||
|
```
|
|
@ -40,6 +40,7 @@ $ pip install lark-parser
|
||||||
* [Program Synthesis is Possible](https://www.cs.cornell.edu/~asampson/blog/minisynth.html) - Creates a DSL for Z3
|
* [Program Synthesis is Possible](https://www.cs.cornell.edu/~asampson/blog/minisynth.html) - Creates a DSL for Z3
|
||||||
* Guides
|
* Guides
|
||||||
* [How to use Lark](how_to_use.md)
|
* [How to use Lark](how_to_use.md)
|
||||||
|
* [How to develop Lark](how_to_develop.md)
|
||||||
* Reference
|
* Reference
|
||||||
* [Grammar](grammar.md)
|
* [Grammar](grammar.md)
|
||||||
* [Tree Construction](tree_construction.md)
|
* [Tree Construction](tree_construction.md)
|
||||||
|
|
Loading…
Reference in New Issue