From 4eb407a9b2a73f0006335e47293aeed2563eeef1 Mon Sep 17 00:00:00 2001 From: shenwei356 Date: Sun, 24 Jul 2016 15:51:11 +0800 Subject: [PATCH] update doc --- README.md | 14 ++------------ doc/docs/download.md | 19 +++++++++++-------- doc/mkdocs.yml | 2 +- doc/site | 2 +- 4 files changed, 15 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 8b57642..dfd5cba 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/doc/docs/download.md b/doc/docs/download.md index f29c349..aec53aa 100644 --- a/doc/docs/download.md +++ b/doc/docs/download.md @@ -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: diff --git a/doc/mkdocs.yml b/doc/mkdocs.yml index 4daf97f..3e3c851 100644 --- a/doc/mkdocs.yml +++ b/doc/mkdocs.yml @@ -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'] diff --git a/doc/site b/doc/site index 74ee352..2bd7163 160000 --- a/doc/site +++ b/doc/site @@ -1 +1 @@ -Subproject commit 74ee3528f8c93abd265ad48f0f25497ee6a30796 +Subproject commit 2bd71639719ae6245acc26969f2480d78328b7f6