Skip to content

Commit c26324b

Browse files
committed
A few typos and some grammar in README.rst
1 parent c9b8553 commit c26324b

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

README.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ The HSD-format is very similar to both JSON and XML, but tries to minimize the
1515
effort for humans to read and write it. It ommits special characters as much as
1616
possible but (in contrast to YAML for example) is not indentation dependent.
1717

18-
It was developed originally developed as the input format for a scientific
19-
simulation tool (DFTB+), but is absolutely general. A typical input written in
20-
HSD would look like ::
18+
It was developed originally as the input format for a scientific simulation tool
19+
(`DFTB+ <https://github.com/dftbplus/dftbplus>`_), but is absolutely general. A
20+
typical input written in HSD looks like ::
2121

2222
driver {
2323
conjugate_gradients {
@@ -49,12 +49,13 @@ HSD would look like ::
4949
}
5050
}
5151

52-
Content in HSD format can be represented as JSON. Content in JSON format can be
53-
represented as HSD, provided it satisfies a restriction for arrays: Either all
54-
elements of an array must be objects or none of them. (This allows for a clear
55-
separation of structure and data and allows for the very simple input format.)
52+
Content in HSD format can be represented as JSON. Content in JSON format can
53+
similarly be represented as HSD, provided it satisfies one restriction for
54+
arrays: Either all elements of an array must be objects or none of them. (This
55+
allows for a clear separation of structure and data and allows for the very
56+
simple input format.)
5657

57-
Content in HSD format can be represented as XML (DOM-tree). Content in XML can
58-
be converted to HSD, provided it satisfies the restriction that every child has
59-
either data (text) or further children, but never both of them. (Again, this
60-
ensures the simplicity of the input format.)
58+
Content in HSD format can be represented as XML (DOM-tree). Likewise content in
59+
XML can be converted to HSD, provided it satisfies the restriction that every
60+
child has either data (text) or further children, but never both of
61+
them. (Again, this ensures the simplicity of the input format.)

0 commit comments

Comments
 (0)