diff options
author | kotfu <kotfu@kotfu.net> | 2019-07-14 00:06:20 -0600 |
---|---|---|
committer | kotfu <kotfu@kotfu.net> | 2019-07-14 00:06:20 -0600 |
commit | 83f62cd6767810382e5a70ec6d0974ef661fc26b (patch) | |
tree | 85ec95043dbbfb1c8231ee9f7d301f9c4b76d15f /docs/migrating/summary.rst | |
parent | 8109e70b0442206103fa5fe1a3af79d1851d7ec1 (diff) | |
download | cmd2-git-83f62cd6767810382e5a70ec6d0974ef661fc26b.tar.gz |
Lots of work on the migrating documentation for #719
Diffstat (limited to 'docs/migrating/summary.rst')
-rw-r--r-- | docs/migrating/summary.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/migrating/summary.rst b/docs/migrating/summary.rst new file mode 100644 index 00000000..5bde2d0c --- /dev/null +++ b/docs/migrating/summary.rst @@ -0,0 +1,15 @@ + +.. _cmd: https://docs.python.org/3/library/cmd.html + +If you're thinking of migrating your cmd_ app to ``cmd2``, this section +will help you decide if it's right for your app, and show you how to +do it. + +* :ref:`migrating/why:Why cmd2` - we try and convince you + to use ``cmd2`` instead of cmd_ +* :ref:`migrating/incompatibilities:Incompatibilities` - ``cmd2`` is not + quite 100% compatible with cmd_. +* :ref:`migrating/minimum:Minimum Required Changes` - the minimum changes + required to move from cmd_ to ``cmd2``. Start your migration here. +* :ref:`migrating/next_steps:Next Steps` - Once you've migrated, here a list + of things you can do next to add even more functionality to your app. |