mirror of
https://github.com/anthonyaxenov/csv2md.git
synced 2024-11-26 07:04:57 +00:00
Update readme
This commit is contained in:
parent
f1aa5d3eff
commit
e7f8f3e3ad
16
README.md
16
README.md
@ -7,14 +7,22 @@ Outputs result in stdout.
|
|||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
csv2md example.csv > example.md # save result to new file
|
csv2md (-h|-help|--help|help) # to get this help
|
||||||
csv2md example.csv | less # view result using pager
|
csv2md example.csv # convert data from file and write result in stdout
|
||||||
|
csv2md < example.csv # convert data from stdin and write result in stdout
|
||||||
|
cat example.csv | csv2md # convert data from stdin and write result in stdout
|
||||||
|
csv2md example.csv > example.md # convert data from file and write result in new file
|
||||||
|
csv2md example.csv | less # convert data from file and write result in stdout using pager
|
||||||
|
csv2md # paste or type data to stdin by hands
|
||||||
|
# press Ctrl+D to view result in stdout
|
||||||
|
csv2md > example.md # paste or type data to stdin by hands
|
||||||
|
# press Ctrl+D to write result in new file
|
||||||
|
|
||||||
...anything is possible with redirection and piping
|
...anything is possible with redirection and piping
|
||||||
```
|
```
|
||||||
|
|
||||||
> **IMPORTANT:**
|
> **IMPORTANT:**
|
||||||
> * input file must be valid csv
|
> * input must be valid csv
|
||||||
> * whitespaces allowed only between double-quotes
|
> * whitespaces allowed only between double-quotes
|
||||||
|
|
||||||
Examples can be found here: https://people.sc.fsu.edu/~jburkardt/data/csv/csv.html
|
Examples can be found here: https://people.sc.fsu.edu/~jburkardt/data/csv/csv.html
|
||||||
@ -22,7 +30,7 @@ Examples can be found here: https://people.sc.fsu.edu/~jburkardt/data/csv/csv.ht
|
|||||||
## Compilation
|
## Compilation
|
||||||
|
|
||||||
1) [Install go](https://go.dev/learn/).
|
1) [Install go](https://go.dev/learn/).
|
||||||
2) Clone this repo.
|
2) Download this repo via zip or `git clone`.
|
||||||
3) Run `make help` to get help or `go run . <csv_path>` to build and run temporary binary.
|
3) Run `make help` to get help or `go run . <csv_path>` to build and run temporary binary.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
Loading…
Reference in New Issue
Block a user