diff options
author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-07-18 21:35:48 -0400 |
---|---|---|
committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-07-18 21:35:48 -0400 |
commit | 1e714557ec6fdca3076038578f9e1e5f43b2722e (patch) | |
tree | 40a5bfa6162e6b1ddc5e43dd0f08c8cc9798071d | |
parent | de6d4933af4201ac6a8c4f7a2b9802dd7ed52cc2 (diff) | |
download | cmd2-git-1e714557ec6fdca3076038578f9e1e5f43b2722e.tar.gz |
Fixed broken links in README.md due to documentation reorganization
Also:
- Moved Examples before API Reference in overall documentation index
- Added an example project
-rwxr-xr-x | README.md | 8 | ||||
-rw-r--r-- | docs/index.rst | 12 |
2 files changed, 11 insertions, 9 deletions
@@ -64,7 +64,7 @@ pip install -U cmd2 cmd2 works with Python 3.5+ on Windows, macOS, and Linux. It is pure Python code with few 3rd-party dependencies. For information on other installation options, see -[Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2 +[Installation Instructions](https://cmd2.readthedocs.io/en/latest/overview/installation.html) in the cmd2 documentation. @@ -109,7 +109,7 @@ Instructions for implementing each feature follow. - Do `help history` in any `cmd2` application for more information - Simple scripting using ASCII text files with one command + arguments per line - - See the [Script files](https://cmd2.readthedocs.io/en/latest/freefeatures.html#script-files) section of the `cmd2` docs for more info + - See the [Command Scripts](https://cmd2.readthedocs.io/en/latest/features/scripting.html#command-scripts) section of the `cmd2` docs for more info - See [script.txt](https://github.com/python-cmd2/cmd2/blob/master/examples/scripts/script.txt) for a trivial example script that can be used in any `cmd2` application with the `run_script` command (or `@` shortcut) @@ -117,7 +117,7 @@ Instructions for implementing each feature follow. - Run arbitrary Python scripts within your `cmd2` application with the ability to also call custom `cmd2` commands - No separate API for your end users to learn - Syntax for calling `cmd2` commands in a `run_pyscript` is essentially identical to what they would enter on the command line - - See the [Python](https://cmd2.readthedocs.io/en/latest/freefeatures.html#python) section of the `cmd2` docs for more info + - See the [Python Scripts](https://cmd2.readthedocs.io/en/latest/features/scripting.html#python-scripts) section of the `cmd2` docs for more info - Also see the [python_scripting.py](https://github.com/python-cmd2/cmd2/blob/master/examples/python_scripting.py) example in conjunction with the [conditional.py](https://github.com/python-cmd2/cmd2/blob/master/examples/scripts/conditional.py) script @@ -367,6 +367,8 @@ Here are a few examples of open-source projects which use `cmd2`: * Automatic analysis of SWF files based on some heuristics. Extensible via plugins. * [tomcatmanager](https://github.com/tomcatmanager/tomcatmanager) * A command line tool and python library for managing a tomcat server +* [Expliot](https://gitlab.com/expliot_framework/expliot) + * Internet of Things (IoT) exploitation framework * [mptcpanalyzer](https://github.com/teto/mptcpanalyzer) * Tool to help analyze mptcp pcaps * [clanvas](https://github.com/marklalor/clanvas) diff --git a/docs/index.rst b/docs/index.rst index c21cfeb1..14da2d20 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -58,22 +58,22 @@ Features features/index -API Reference -============= +Examples +======== .. toctree:: :maxdepth: 2 - api/index + examples/index -Examples -======== +API Reference +============= .. toctree:: :maxdepth: 2 - examples/index + api/index Meta |