Rooba
/
lark
mirror of https://github.com/lark-parser/lark.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Moved development instructions from README.md to docs

This commit is contained in:
evandrocoan 2018-12-23 16:10:38 -02:00 committed by Erez Shinan
parent 92b312df8e
commit 3fb0c48557
3 changed files with 41 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -165,38 +165,7 @@ Lark uses the [MIT license](LICENSE).
## Contribute
Lark is currently accepting pull-requests.
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
```
Lark is currently accepting pull-requests. See [How to develop Lark](/docs/how_to_develop.md)
## Donate

39
docs/how_to_develop.md Normal file
View File

@ -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
```

1
docs/index.md
View File

@ -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
* Guides
* [How to use Lark](how_to_use.md)
* [How to develop Lark](how_to_develop.md)
* Reference
* [Grammar](grammar.md)
* [Tree Construction](tree_construction.md)