Mercurial > public > cpp-enigma

comparison README.rst @ 21:42593b23e738 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Sigh, still messed up. Another attempt.
author Brian Neal <bgneal@gmail.com>
date Wed, 11 Jul 2012 20:26:15 -0500
parents 3a69c0c2d7dc
children
comparison
equal deleted inserted replaced
20:3a69c0c2d7dc 21:42593b23e738
107 $ scons check 107 $ scons check
108 108
109 I have not currently compiled the code on other compilers or environments. 109 I have not currently compiled the code on other compilers or environments.
110 Patches or pull requests are welcome. 110 Patches or pull requests are welcome.
111 111
112
112 Documentation 113 Documentation
113 ------------- 114 -------------
114 115
115 Currently there is no documentation for Cpp-Enigma. However the design and API 116 Currently there is no documentation for Cpp-Enigma. However the design and API
116 is almost identical to Py-Enigma, which is well documented. I will quote from 117 is almost identical to Py-Enigma, which is well documented. I will quote from
122 `download it in a variety of formats 123 `download it in a variety of formats
123 <http://readthedocs.org/projects/py-enigma/downloads/>`_. 124 <http://readthedocs.org/projects/py-enigma/downloads/>`_.
124 125
125 Sources for the documentation are also included in Sphinx_ format. If you 126 Sources for the documentation are also included in Sphinx_ format. If you
126 install Sphinx you can generate the documentation in several output formats. 127 install Sphinx you can generate the documentation in several output formats.
128
129 Between the Python docs and the source code hopefully this will be enough to get
130 you going. Proper documentation may be created in the future. Again, patches and
131 pull requests are welcome.
127 132
128 133
129 Support 134 Support
130 ------- 135 -------
131 136