From 3fb0c4855700788d40d8ed7d3cba3b23b0943926 Mon Sep 17 00:00:00 2001 From: evandrocoan Date: Sun, 23 Dec 2018 16:10:38 -0200 Subject: [PATCH] Moved development instructions from README.md to docs --- README.md | 33 +-------------------------------- docs/how_to_develop.md | 39 +++++++++++++++++++++++++++++++++++++++ docs/index.md | 1 + 3 files changed, 41 insertions(+), 32 deletions(-) create mode 100644 docs/how_to_develop.md diff --git a/README.md b/README.md index db22932..dd37660 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/how_to_develop.md b/docs/how_to_develop.md new file mode 100644 index 0000000..c989444 --- /dev/null +++ b/docs/how_to_develop.md @@ -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 +``` diff --git a/docs/index.md b/docs/index.md index fbaef83..8517208 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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)