mirror of
https://github.com/anthonyaxenov/csv2md.git
synced 2024-11-22 13:25:03 +00:00
Readme
This commit is contained in:
parent
d7ffa94db5
commit
1dbd735d93
25
README.md
25
README.md
@ -4,20 +4,27 @@ Stupidly simple tool to convert csv-file to [markdown](https://spec-md.com/) tab
|
||||
|
||||
Outputs result in stdout.
|
||||
|
||||
Building:
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
make help
|
||||
```
|
||||
csv2md example.csv > example.md # save result to new file
|
||||
csv2md example.csv | less # view result using pager
|
||||
|
||||
Usage:
|
||||
|
||||
```shell
|
||||
csv2md example.csv > example.md # makes new file
|
||||
csv2md example.csv | less # view result using *pager*
|
||||
...anything is possible with redirection and piping
|
||||
```
|
||||
|
||||
> **IMPORTANT:** input must be valid csv and whitespaces are allowed only between double-quotes.
|
||||
> **IMPORTANT:**
|
||||
> * input file must be valid csv
|
||||
> * whitespaces allowed only between double-quotes
|
||||
|
||||
Examples can be found here: https://people.sc.fsu.edu/~jburkardt/data/csv/csv.html
|
||||
|
||||
## Compilation
|
||||
|
||||
1) [Install go](https://go.dev/learn/).
|
||||
2) Clone this repo.
|
||||
3) Run `make help` to get help or `go run . <csv_path>` to build and run temporary binary.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
Loading…
Reference in New Issue
Block a user