Skip to content

Commit

Permalink
[docs]: Adding commands section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
hentt30 committed Jun 6, 2021
1 parent 8cb1721 commit 453e504
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ is equivalent to the standard DFT approach and and is three orders of magnitude

.. figure:: docs/source/images/dft_05_demonstration.png
:align: center
:width: 600
:width: 300

Fig 1. Comparison of calculated band gaps with experiment. The red square are the SCF LDA-1/2 (standard
LDA-1/2). The crosses are standard LDA. The small gap semiconductors are metals (negative gaps), when calculated with
Expand Down Expand Up @@ -65,6 +65,21 @@ Currently, the following softwares are supported by the program:

- VASP

Commands
-----------
.. toctree::
:maxdepth: 2
:caption: Contents:

/docs/source/vbm-character
/docs/source/cbm-character
/docs/source/band-character
/docs/source/band-gap
/docs/source/run-atomic
/docs/source/occupation
/docs/source/create-input
/docs/source/correct-potfile
/docs/source/execute

More information
------------------------
Expand Down

0 comments on commit 453e504

Please sign in to comment.