Skip to content

Commit 8cb3bee

Browse files
committed
docs(readme): improve writing
[ci skip]
1 parent 1892e63 commit 8cb3bee

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# csv2html
22

33
This command-line utility converts [CSV files](http://en.wikipedia.org/wiki/Comma-separated_values) to HTML tables and complete HTML documents.
4-
It requires Rust 1.74 or later to build.
5-
By default, it uses the first row of the CSV file as the [header](https://developer.mozilla.org/en/docs/Web/HTML/Element/th) of the HTML table.
4+
It can use the first row of the CSV file as the [header](https://developer.mozilla.org/en/docs/Web/HTML/Element/th) of the table, and does so by default.
65

76
The original Python version of csv2html is preserved in the branch [`python`](https://github.com/dbohdan/csv2html/tree/python).
87

@@ -12,6 +11,8 @@ The original Python version of csv2html is preserved in the branch [`python`](ht
1211
Prebuilt Linux and Windows binaries are available.
1312
They are attached to releases on the ["Releases"](https://github.com/dbohdan/csv2html/releases) page.
1413

14+
csv2html requires Rust 1.74 or later to build.
15+
1516
### Installing with Cargo
1617

1718
```sh
@@ -23,7 +24,7 @@ cargo install csv2html
2324
Follow the instructions to build a static Linux binary of csv2html from the source code on recent Debian and Ubuntu.
2425

2526
1\. Install [Rustup](https://rustup.rs/).
26-
Through Rustup add the stable musl libc target for your CPU.
27+
Through Rustup, add the stable musl libc target for your CPU.
2728

2829
```sh
2930
rustup target add x86_64-unknown-linux-musl
@@ -51,7 +52,7 @@ just release-linux
5152
Follow the instructions to build a 32-bit Windows binary of csv2html on recent Debian and Ubuntu.
5253

5354
1\. Install [Rustup](https://rustup.rs/).
54-
Through Rustup add the i686 GNU ABI Windows target.
55+
Through Rustup, add the i686 GNU ABI Windows target.
5556

5657
```sh
5758
rustup target add i686-pc-windows-gnu
@@ -112,14 +113,14 @@ up to the user to ensure the result is valid HTML
112113

113114
## Use examples
114115

115-
The following command reads the data in `test/test.csv` and writes an HTML table that corresponds to the data to `test.html`:
116+
This command reads data from `test/test.csv` and writes an HTML table to `test.html`:
116117

117118
```sh
118119
csv2html -o test.html tests/test.csv
119120
```
120121

121122
The following command takes semicolon-delimited data from `pub.csv`, starting with row 267.
122-
The first column of the table is replaced with the row number starting at 1 (except in the header row, which is untouched).
123+
It replaces the first column of the table with the row number starting at 1 (except in the header row, which is not changed).
123124
The output is redirected to the file `pub.html`.
124125

125126
```sh

0 commit comments

Comments
 (0)