Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
shenwei356 committed Jul 24, 2016
1 parent b06dd98 commit 4eb407a
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 22 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,11 @@
# csvtk
# csvtk - another cross-platform, efficient, practical and pretty CSV/TSV toolkit

Another cross-platform, efficient, practical and pretty CSV/TSV toolkit

Yes, you could just use spreadsheet softwares like MS excel to
do most of the job.

However it's all by clicking and typing, which is **not
automatically and time-consuming to repeat**, especially when we want to
apply similar operations with different datasets or purposes.
[![Latest Stable Version](https://img.shields.io/github/release/shenwei356/csvtk.svg?style=flat)](https://github.com/shenwei356/csvtk/releases)

`csvtk` is **convenient for rapid investigation
and also easy to integrated into analysis pipelines**.
It could save you much time of writing scripts.

Hope it be helpful to you.


## Features

- **Cross-platform** (Linux/Windows/Mac OS X/OpenBSD/FreeBSD)
Expand Down
19 changes: 11 additions & 8 deletions doc/docs/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,22 @@
in [release](https://github.com/shenwei356/csvtk/releases) page.

Just [download](https://github.com/shenwei356/csvtk/releases) compressed
executable file of your operating system, and uncompress it with `tar -zxvf *.tar.gz` command.
executable file of your operating system,
and uncompress it with `tar -zxvf *.tar.gz` command or other tools.
And then:

You can add the directory of the executable file to environment variable
`PATH`, so you can run `csvtk` anywhere.
1. **For Linux-like systems**
1. If you have root privilege simply copy it to `/usr/local/bin`:

1. For windows, the simplest way is copy it to `C:\WINDOWS\system32`.
sudo cp csvtk /usr/local/bin/

2. For Linux, type:
1. Or add the directory of the executable file to environment variable
`PATH`:

chmod a+x /PATH/OF/CSVTK/csvtk
echo export PATH=\$PATH:/PATH/OF/CSVTK >> ~/.bashrc
echo export PATH=\$PATH:/PATH/OF/csvtk >> ~/.bashrc

or simply copy it to `/usr/local/bin`

1. **For windows**, just copy `csvtk.exe` to `C:\WINDOWS\system32`.

For Go developer, just one command:

Expand Down
2 changes: 1 addition & 1 deletion doc/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ theme: mkdocs
repo_url: https://github.com/shenwei356/csvtk
site_description: csvtk - CSV/TSV toolkit
site_author: shenwei356
google_analytics: ['UA-28948626-3', 'blog.shenwei.me/csvtk']
google_analytics: ['UA-28948626-9', 'blog.shenwei.me/csvtk']
2 changes: 1 addition & 1 deletion doc/site
Submodule site updated from 74ee35 to 2bd716

0 comments on commit 4eb407a

Please sign in to comment.