<reponame>kummahiih/pyqbit
#    @copyright: 2020 by <NAME>
#    @license: MIT <http://www.opensource.org/licenses/mit-license.php>


import qbit

README =  "# pyqbit" + "\n"
README += "Quantum bit and the usual gates in numeric forms straight from the Wikipedia."
README += '\n## apply'+ "\n" + qbit.apply.__doc__
README += '\n## Quantum bit definitions\n'
README += '\n### Zero'+ "\n" + qbit.Zero.__doc__
README += '\n### One'+ "\n" + qbit.One.__doc__
README += '\n### Plus'+ "\n" + qbit.Plus.__doc__
README += '\n### Minus'+ "\n" + qbit.Minus.__doc__
README += '\n### Measure'+ "\n" + qbit.Measure.__doc__
README += '\n### Combine'+ "\n" + qbit.Combine.__doc__
README += '\n### equal'+ "\n" + qbit.equal.__doc__
README += '\n## Quantum gates\n'
README += '\n### Identity'+ "\n" + qbit.Identity.__doc__
README += '\n### H'+ "\n" + qbit.H.__doc__
README += '\n### PauliX'+ "\n" + qbit.PauliX.__doc__
README += '\n### PauliY'+ "\n" + qbit.PauliY.__doc__
README += '\n### PauliZ'+ "\n" + qbit.PauliZ.__doc__
README += '\n### Phase'+ "\n" +  qbit.Phase.__doc__
README += '\n### R'+ "\n" + qbit.R.__doc__
README += '\n### CNOT'+ "\n" + qbit.CNOT.__doc__
README += '\n### CPauliZ'+ "\n" + qbit.CPauliZ.__doc__
README += '\n### SWAP'+ "\n" + qbit.SWAP.__doc__
README += '\n## Pauli group\n'
README += '\n### P1'+ "\n" + qbit.P1.__doc__
README += '\n### Pn'+ "\n" + qbit.Pn.__doc__
README += '\n## Stabilizer codes\n'
README += '\n### S_5_1_3'+ "\n" + qbit.S_5_1_3.__doc__


with open('README.md', 'wt') as readme_file:
    readme_file.write(README)