diff --git a/README.md b/README.md index ea2c819..e978807 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ Camelot is a Python library and command-line tool for extracting tables from PDF ### Command-line interface
+$ camelot --help
 Usage: camelot [OPTIONS] FILEPATH
 
 Options:
@@ -105,7 +106,7 @@ The dependencies include [tk](https://wiki.tcl.tk/3743) and [ghostscript](https:
 Make sure you have the most updated versions for `pip` and `setuptools`. You can update them by
 
 
-pip install -U pip setuptools
+$ pip install -U pip setuptools
 
### Installing dependencies @@ -117,25 +118,25 @@ tk and ghostscript can be installed using your system's default package manager. * Ubuntu
-sudo apt-get install python-tk ghostscript
+$ sudo apt-get install python-tk ghostscript
 
* Arch Linux
-sudo pacman -S tk ghostscript
+$ sudo pacman -S tk ghostscript
 
#### OS X
-brew install tcl-tk ghostscript
+$ brew install tcl-tk ghostscript
 
Finally, `cd` into the project directory and install by
-python setup.py install
+$ python setup.py install
 
## Development @@ -155,5 +156,5 @@ See [Contributing guidelines](). ### Testing
-python setup.py test
+$ python setup.py test
 
\ No newline at end of file diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst index 5da0c10..065aba8 100644 --- a/docs/dev/contributing.rst +++ b/docs/dev/contributing.rst @@ -12,7 +12,7 @@ The preferred way to contribute to Camelot is to fork this repository, and then 3. Clone this copy to your local disk. 4. Create a branch to hold your changes:: - git checkout -b my-feature + $ git checkout -b my-feature and start making changes. Never work in the `master` branch! @@ -32,7 +32,7 @@ Code You can check the latest sources with the command:: - git clone https://github.com/socialcopsdev/camelot.git + $ git clone https://github.com/socialcopsdev/camelot.git Contributing ------------ @@ -44,4 +44,4 @@ Testing :: - python setup.py test \ No newline at end of file + $ python setup.py test \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 6aa0f1f..e3a56dd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -58,6 +58,7 @@ Usage :: + $ camelot --help Usage: camelot [OPTIONS] FILEPATH Options: diff --git a/docs/user/install.rst b/docs/user/install.rst index a644c74..13ec7d5 100644 --- a/docs/user/install.rst +++ b/docs/user/install.rst @@ -5,7 +5,7 @@ Installation Make sure you have the most updated versions for `pip` and `setuptools`. You can update them by:: - pip install -U pip setuptools + $ pip install -U pip setuptools The dependencies include `tk`_ and `ghostscript`_. @@ -24,21 +24,21 @@ Linux :: - sudo apt-get install python-opencv python-tk ghostscript + $ sudo apt-get install python-opencv python-tk ghostscript * Arch Linux :: - sudo pacman -S opencv tk ghostscript + $ sudo pacman -S opencv tk ghostscript OS X ^^^^ :: - brew install homebrew/science/opencv ghostscript + $ brew install homebrew/science/opencv ghostscript Finally, `cd` into the project directory and install by:: - python setup.py install \ No newline at end of file + $ python setup.py install \ No newline at end of file