diff --git a/doc/README.md b/doc/README.md index a391f8a..8ae69c6 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,20 +1,22 @@ +Setting up your development environment +======================================== 1. Install the dependencies via pip with the script below. ```Shell python scripts/dev_setup.py - + ``` 2. Add `\src` to your PYTHONPATH environment variable: - - #####Windows + + ##### Windows ```BatchFile set PYTHONPATH=\src;%PYTHONPATH% ``` - #####OSX/Ubuntu (bash) + + ##### OSX/Ubuntu (bash) ```Shell export PYTHONPATH=/src:${PYTHONPATH} - -##Running Tests: -####Command line -#####Windows: + ``` +## Running Tests: +#### Command line Provided your PYTHONPATH was set correctly, you can run the tests from your `` directory. To test the common modules of the CLI: @@ -27,4 +29,4 @@ python -m unittest discover -s src/mssqlscripter/mssql/scripter/tests ``` - Additionally, you can run tests for all CLI tools and common modules using the `Run_All_Tests.bat` script. + Additionally, you can run tests for all CLI tools and common modules using the `run_all_tests.bat` or `sh run_all_tests` script. diff --git a/scripts/Run_All_Tests b/scripts/run_all_tests.sh similarity index 100% rename from scripts/Run_All_Tests rename to scripts/run_all_tests.sh