summaryrefslogtreecommitdiffstats
path: root/doc/INSTALL.markdown
blob: 1d4f0d4a6ef2bd9f8b818509e3d9914407736192 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# q - Treating Text as a Database 

## Requirements
* Just Python 2.5 and up or Python 2.4 with sqlite3 module installed. Python 3.x is not supported yet.

## Installation
Current stable release is `1.3.0`.

### Mac Users
Just run `brew install q`. 

Thanks @stuartcarnie for the initial homebrew formula

### RPM-Base Linux distributions
Download the RPM here **[here](https://github.com/harelba/packages-for-q/raw/master/rpms/q-1.3.0-1.noarch.rpm)**. 

Install using `rpm -ivh <rpm-name>`.

RPM Releases also contain a man page. Just enter `man q`.

### Debian-based Linux distributions
Debian packaing is in progress. In the mean time install manually. See the section below.

### Manual installation

Download the main q executable from [here](https://raw.github.com/harelba/q/1.3.0/q) into a folder in the PATH.

Make the file executable.

For `Windows` machines, also download q.bat [here](https://raw.github.com/harelba/q/1.3.0/q.bat) into the same folder and use it to run q.

## Default settings file
q supports an option file in ~/.qrc or in the working directory (with the name .qrc) which provides defaults for some or all of the command line options. A sample .qrc file with commented-out options is included. Just put it in your home folder and modify it according to your needs.

## Contact
Any feedback/suggestions/complaints regarding this tool would be much appreciated. Contributions are most welcome as well, of course.

Harel Ben-Attia, harelba@gmail.com, [@harelba](https://twitter.com/harelba) on Twitter