Skip to content

Commit

Permalink
Add development setup instructions to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rfst committed Jun 28, 2024
1 parent b465c7c commit 30f289b
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .run/mobt start -m R,F b.run.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="mobt start -m R,F b" type="PythonConfigurationType" factoryName="Python">
<module name="mob-tool" />
<option name="ENV_FILES" value="" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="PARENT_ENVS" value="true" />
<envs>
<env name="PYTHONUNBUFFERED" value="1" />
</envs>
<option name="SDK_HOME" value="" />
<option name="SDK_NAME" value="Python 3.11 (mob-tool)" />
<option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
<option name="IS_MODULE_SDK" value="false" />
<option name="ADD_CONTENT_ROOTS" value="true" />
<option name="ADD_SOURCE_ROOTS" value="true" />
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
<option name="SCRIPT_NAME" value="$PROJECT_DIR$/venv/bin/mobt" />
<option name="PARAMETERS" value="start -m R,F b" />
<option name="SHOW_COMMAND_LINE" value="false" />
<option name="EMULATE_TERMINAL" value="true" />
<option name="MODULE_MODE" value="false" />
<option name="REDIRECT_INPUT" value="false" />
<option name="INPUT_FILE" value="" />
<method v="2" />
</configuration>
</component>
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ Here's an example of the output of the `done` command:

![Example of mobt done output](https://raw.githubusercontent.com/stavarengo/mob-tool/main/docs/done-output.png)

## Development Setup

To set up the development environment, follow these steps:
- Clone the repository
- Create a virtual environment with `python -m venv venv`.
- Install the app from the local repository with `pip install -e .`


## FAQ

### What happens if one of the Git commands fails?
Expand Down

0 comments on commit 30f289b

Please sign in to comment.