Skip to content

Commit 51fac97

Browse files
committed
Added a link to the example applications from top-level README
1 parent 250ec01 commit 51fac97

File tree

1 file changed

+28
-25
lines changed

1 file changed

+28
-25
lines changed

README.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -39,30 +39,30 @@ The price we pay for beautifully colored displays is complexity required to aggr
3939
The `cmd2` framework provides a great mixture of both worlds. Application designers can easily create complex applications and rely on the cmd2 library to offer effortless user facing help and extensive tab completion.
4040
When users become comfortable with functionality, cmd2 turns into a feature rich library enabling a smooth transition to full automation. If designed with enough forethought, a well implemented cmd2 application can serve as a boutique workflow tool. `cmd2` pulls off this flexibility based on two pillars of philosophy:
4141

42-
- Tab Completion
43-
- Automation Transition
42+
- Tab Completion
43+
- Automation Transition
4444

4545
## Philosophy
4646

4747
<a href="https://imgflip.com/i/63h03x"><img src="https://i.imgflip.com/63h03x.jpg" title="made at imgflip.com" width="70%" height="%70"/></a>
4848

4949
Deep extensive tab completion and help text generation based on the argparse library create the first pillar of 'ease of command discovery'. The following is a list of features in this category.
5050

51-
- Great tab completion of commands, subcommands, file system paths, and shell commands.
52-
- Custom tab completion for user designed commands via simple function overloading.
53-
- Tab completion from `persistent_history_file` sources added with very little friction.
54-
- Automatic tab completion of `argparse` flags and optional arguments.
55-
- Path completion easily enabled.
56-
- When all else fails, custom tab completion based on `choices_provider` can fill any gaps.
51+
- Great tab completion of commands, subcommands, file system paths, and shell commands.
52+
- Custom tab completion for user designed commands via simple function overloading.
53+
- Tab completion from `persistent_history_file` sources added with very little friction.
54+
- Automatic tab completion of `argparse` flags and optional arguments.
55+
- Path completion easily enabled.
56+
- When all else fails, custom tab completion based on `choices_provider` can fill any gaps.
5757

5858
<a href="https://imgflip.com/i/66t0y0"><img src="https://i.imgflip.com/66t0y0.jpg" title="made at imgflip.com" width="70%" height="70%"/></a>
5959

6060
cmd2 creates the second pillar of 'ease of transition to automation' through alias/macro creation, command line argument parsing and execution of cmd2 scripting.
6161

62-
- Flexible alias and macro creation for quick abstraction of commands.
63-
- Text file scripting of your application with `run_script` (`@`) and `_relative_run_script` (`@@`)
64-
- Powerful and flexible built-in Python scripting of your application using the `run_pyscript` command
65-
- Transcripts for use with built-in regression can be automatically generated from `history -t` or `run_script -t`
62+
- Flexible alias and macro creation for quick abstraction of commands.
63+
- Text file scripting of your application with `run_script` (`@`) and `_relative_run_script` (`@@`)
64+
- Powerful and flexible built-in Python scripting of your application using the `run_pyscript` command
65+
- Transcripts for use with built-in regression can be automatically generated from `history -t` or `run_script -t`
6666

6767
## Installation
6868

@@ -88,14 +88,17 @@ The best way to learn the cmd2 api is to delve into the example applications loc
8888

8989
## Tutorials
9090

91-
- PyOhio 2019 presentation:
92-
- [video](https://www.youtube.com/watch?v=pebeWrTqIIw)
93-
- [slides](https://github.com/python-cmd2/talks/blob/master/PyOhio_2019/cmd2-PyOhio_2019.pdf)
94-
- [example code](https://github.com/python-cmd2/talks/tree/master/PyOhio_2019/examples)
95-
- [Cookiecutter](https://github.com/cookiecutter/cookiecutter) Templates from community
96-
- Basic cookiecutter template for cmd2 application : https://github.com/jayrod/cookiecutter-python-cmd2
97-
- Advanced cookiecutter template with external plugin support : https://github.com/jayrod/cookiecutter-python-cmd2-ext-plug
98-
- [Example Applications](https://github.com/jayrod/cmd2-example-apps)
91+
- PyOhio 2019 presentation:
92+
- [video](https://www.youtube.com/watch?v=pebeWrTqIIw)
93+
- [slides](https://github.com/python-cmd2/talks/blob/master/PyOhio_2019/cmd2-PyOhio_2019.pdf)
94+
- [example code](https://github.com/python-cmd2/talks/tree/master/PyOhio_2019/examples)
95+
- [Cookiecutter](https://github.com/cookiecutter/cookiecutter) Templates from community
96+
- Basic cookiecutter template for cmd2 application : https://github.com/jayrod/cookiecutter-python-cmd2
97+
- Advanced cookiecutter template with external plugin support : https://github.com/jayrod/cookiecutter-python-cmd2-ext-plug
98+
- [cmd2 example applications](https://github.com/python-cmd2/cmd2/tree/master/examples)
99+
- Basic cmd2 examples to demonstrate how to use various features
100+
- [Advanced Examples](https://github.com/jayrod/cmd2-example-apps)
101+
- More complex examples that demonstrate more featuers about how to put together a complete application
99102

100103
## Hello World
101104

@@ -122,11 +125,11 @@ if __name__ == '__main__':
122125

123126
If you think you've found a bug, please first read through the open [Issues](https://github.com/python-cmd2/cmd2/issues). If you're confident it's a new bug, go ahead and create a new GitHub issue. Be sure to include as much information as possible so we can reproduce the bug. At a minimum, please state the following:
124127

125-
- `cmd2` version
126-
- Python version
127-
- OS name and version
128-
- What you did to cause the bug to occur
129-
- Include any traceback or error message associated with the bug
128+
- `cmd2` version
129+
- Python version
130+
- OS name and version
131+
- What you did to cause the bug to occur
132+
- Include any traceback or error message associated with the bug
130133

131134
## Projects using cmd2
132135

0 commit comments

Comments
 (0)