summaryrefslogtreecommitdiffstats
path: root/INSTALL.markdown
diff options
context:
space:
mode:
authorHarel Ben-Attia <harelba@gmail.com>2014-03-09 10:53:58 -0400
committerHarel Ben-Attia <harelba@gmail.com>2014-03-09 10:53:58 -0400
commit0cf62064accb88d98a21874601922cc4e31fd04b (patch)
treed3931506332ece7e939bdf826c3fa18863dd852c /INSTALL.markdown
parent24b298321cc79785de8edfcbbc2ea8cc7d247b9b (diff)
Fixed installation doc
Diffstat (limited to 'INSTALL.markdown')
-rw-r--r--INSTALL.markdown33
1 files changed, 21 insertions, 12 deletions
diff --git a/INSTALL.markdown b/INSTALL.markdown
index 14adb34..54911b8 100644
--- a/INSTALL.markdown
+++ b/INSTALL.markdown
@@ -4,25 +4,34 @@
* Just Python 2.5 and up or Python 2.4 with sqlite3 module installed.
## Installation
-* Mac users can use homebrew to install q - Just run `brew install q` (Thanks @stuartcarnie)
-* RPM Packaging is ready. You can download the RPM from the link below.
-* Debian Packaging will come soon.
+Current stable release is `1.3.0`.
- __**Latest version `1.3.0`**__
-
- **RPM of the latest version** - Can be downloaded **[here](https://github.com/harelba/packages-for-q/raw/master/rpms/q-1.3.0-1.noarch.rpm)**. The RPM package also includes a man page. Just enter `man q`
+### Mac Users
+Just run `brew install q`.
- **Manual installation of the latest version** - Download the main q executable from **[here](https://raw.github.com/harelba/q/1.3.0/q)** into a folder in the path and make the file executable
+Thanks @stuartcarnie for the initial homebrew formula
+### RPM-Base Linux distributions
+RPM Releases also contain a man page. Just enter `man q`.
- __**Previous version is `1.2.0`**__
-
- **RPM of the previous version** - Can be downloaded **[here](https://github.com/harelba/packages-for-q/raw/master/rpms/q-1.2.0-1.noarch.rpm)**. Includes man page. Just enter `man q`
+**Latest version `1.3.0`
- **Manual installation of the previous version** - If for some reason you need the previous version, you can download the main q executable from **[here](https://raw.github.com/harelba/q/1.2.0/q)** into a folder in the path and make the file executable. Please notify me of any such case, so I can understand the reason and fix things if needed.
+Download the RPM here **[here](https://github.com/harelba/packages-for-q/raw/master/rpms/q-1.3.0-1.noarch.rpm)**.
-**NOTE:** If you're using Python 2.4, then you will have to install the sqlite3 package for q to work.
+Install using `rpm -ivh <rpm-name>`.
+### 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