Mercurial > public > m209

comparison docs/index.rst @ 52:5b335e8af407

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Started roughing in some docs using Sphinx.
author Brian Neal <bgneal@gmail.com>
date Thu, 04 Jul 2013 22:41:30 -0500
parents 9c994664fdd6
children 7fd3ec5580ab
comparison
equal deleted inserted replaced
51:9c994664fdd6 52:5b335e8af407
3 You can adapt this file completely to your liking, but it should at least 3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive. 4 contain the root `toctree` directive.
5 5
6 Welcome to m209's documentation! 6 Welcome to m209's documentation!
7 ================================ 7 ================================
8
9 :Author: Brian Neal <bgneal@gmail.com>
10 :Version: |release|
11 :Date: |today|
12 :Home Page: https://bitbucket.org/bgneal/m209/
13 :License: MIT License (see LICENSE.txt)
14 :Documentation: http://m209.readthedocs.org/
15 :Support: https://bitbucket.org/bgneal/m209/issues
16
17 Introduction
18 ------------
19
20 ``m209`` is a complete `M-209`_ simulation library and command-line application
21 written in Python 3. ``m209`` is historically accurate, meaning that it can
22 exchange messages with an actual M-209 cipher machine.
23
24 It is hoped that this library will be useful to M-209 enthusiasts, historians,
25 and students interested in cryptography.
26
27 ``m209`` strives to be Pythonic, easy to use, and comes with both unit tests
28 and documentation. ``m209`` is a library for building applications for
29 encrypting and decrypting M-209 messages. ``m209`` also ships with a simple
30 command-line application that can encrypt & decrypt messages for scripting and
31 experimentation.
32
33 Command-line Example
34 --------------------
35
36 Library Example
37 ---------------
38
39 Requirements
40 ------------
41
42 ``m209`` is written in Python_, specifically Python 3.3. It has no other
43 requirements or dependencies.
44
45 Installation
46 ------------
47
48 ``m209`` is available on the `Python Package Index`_ (PyPI). You can install it
49 using pip_::
50
51 $ pip install m209 # install
52 $ pip install --upgrade m209 # upgrade
53
54 You may also download a tarball or .zip file of the latest code using the "get
55 source" link on the `m209 Bitbucket page`_. Alternatively if you use
56 Mercurial_, you can clone the repository with the following command::
57
58 $ hg clone https://bitbucket.org/bgneal/m209
59
60 If you did not use pip, you can install with this command::
61
62 $ python setup.py install
63
64
65 Support & Source
66 ----------------
67
68 All support takes place at the `m209 Bitbucket page`_. Please enter any
69 feature requests or bugs into the `issue tracker`_.
70
71 Next Steps
72 ----------
8 73
9 Contents: 74 Contents:
10 75
11 .. toctree:: 76 .. toctree::
12 :maxdepth: 2 77 :maxdepth: 2
18 83
19 * :ref:`genindex` 84 * :ref:`genindex`
20 * :ref:`modindex` 85 * :ref:`modindex`
21 * :ref:`search` 86 * :ref:`search`
22 87
88
89 .. _M-209: http://en.wikipedia.org/wiki/M-209
90 .. _Python: http://www.python.org
91 .. _Python Package Index: http://pypi.python.org/pypi/m209/
92 .. _m209 Bitbucket page: https://bitbucket.org/bgneal/m209
93 .. _pip: http://www.pip-installer.org
94 .. _Mercurial: http://mercurial.selenic.com/
95 .. _issue tracker: https://bitbucket.org/bgneal/m209/issues