Adding doc/ dir.

This commit is contained in:
Martin Dvorak 2014-04-27 13:31:39 +02:00
parent 492a366d0f
commit 3d62590247
2 changed files with 115 additions and 1 deletions

114
doc/INSTALL.md Normal file
View file

@ -0,0 +1,114 @@
UBUNTU INSTALLATION
-------------------
* install `hh` on Ubuntu (12.04LTS/12.10/13.10/14.04LTS):
```bash
sudo add-apt-repository ppa:ultradvorka/ppa
sudo apt-get update
sudo apt-get install hh
```
* optionally configure `hh`:
```bash
hh --show-configuration >> ~/.bashrc
```
INSTALLATION FROM SOURCE CODE
-----------------------------
* Clone Git repository:
```bash
git clone https://github.com/dvorka/hstr.git
```
* create build files using:
```bash
cd ./dist && ./1-dist.sh && cd ..
```
* install `hh` using:
```bash
./configure && make && make install
```
* optionally configure `hh`:
```bash
hh --show-configuration >> ~/.bashrc
```
DISTRIBUTION INSTALLATION
-------------------------
* download latest distribution from project Releases section:
https://github.com/dvorka/hstr/releases
* expand the archive and install `hh` using:
```bash
./configure && make && make install
```
* optionally configure `hh`:
```bash
hh --show-configuration >> ~/.bashrc
```
DEBIAN/MINT INSTALLATION
-------------------
* install `hh` on Debian (Wheezy) or Mint (13) by registering the key:
```bash
wget www.clfh.de/frankh.asc
apt-key add frankh.asc
```
adding the repository:
```bash
deb http://www.clfh.de/debian wheezy main
deb-src http://www.clfh.de/debian wheezy main
```
and installing it:
```bash
apt-get update
apt-get install hh
```
* optionally configure `hh`:
```bash
hh --show-configuration >> ~/.bashrc
```
ARCH LINUX
----------
* download latest distribution from project Releases section:
https://github.com/dvorka/hstr/releases
* use PKGBUILD in the root of the distribution to build package using `makepkg`:
https://wiki.archlinux.org/index.php/PKGBUILD
* install `hh`
* optionally configure `hh`:
```bash
hh --show-configuration >> ~/.bashrc
```
MAC OS
------
* install MacPorts:
http://www.macports.org
* set the environment:
```bash
env CFLAGS="-I/opt/local/include -I/usr/include" LDFLAGS="-L/opt/local/lib -L/usr/lib" ./configure
```
* finish the installation
```bash
make && make install
```
* optionally configure `hh`:
```bash
hh --show-configuration >> ~/.bashrc
```

View file

@ -181,7 +181,7 @@ void hstr_init(Hstr *hstr)
hstr->selectionRegexpMatch=NULL;
hstr->selectionSize=0;
hstr->historyMatch=HH_MATCH_REGEXP;
hstr->historyMatch=HH_MATCH_EXACT;
hstr->historyView=HH_VIEW_RANKING;
hstr->caseSensitive=HH_CASE_INSENSITIVE;