diff options
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | docs/install.rst | 4 |
2 files changed, 3 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f7eba2fa..e0cbd57b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -236,7 +236,7 @@ This bit is up to you! #### How to find the code in the cmd2 codebase to fix/edit? The cmd2 project directory structure is pretty simple and straightforward. All actual code for cmd2 -is located in a single file, `cmd2.py`. The code to generate the documentation is in the `docs` directory. Unit tests are in the `tests` directory. The `examples` directory contains examples of how +is located underneath the `cmd2` directory. The code to generate the documentation is in the `docs` directory. Unit tests are in the `tests` directory. The `examples` directory contains examples of how to use cmd2. There are various other files in the root directory, but these are primarily related to continuous integration and to release deployment. diff --git a/docs/install.rst b/docs/install.rst index be7c61dd..6baf4078 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -88,10 +88,10 @@ This will also install the required 3rd-party dependencies. Deploy cmd2.py with your project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -``cmd2`` is contained in only one Python file (**cmd2.py**), so it can be easily copied into your project. *The +``cmd2`` is contained in a small number of Python files, which can be easily copied into your project. *The copyright and license notice must be retained*. -This is an option suitable for advanced Python users. You can simply include this file within your project's hierarchy. +This is an option suitable for advanced Python users. You can simply include the files within your project's hierarchy. If you want to modify ``cmd2``, this may be a reasonable option. Though, we encourage you to use stock ``cmd2`` and either composition or inheritance to achieve the same goal. |