summaryrefslogtreecommitdiffstats
path: root/INSTALL.markdown
diff options
context:
space:
mode:
authorHarel Ben-Attia <harelba@gmail.com>2014-03-09 06:07:53 -0400
committerHarel Ben-Attia <harelba@gmail.com>2014-03-09 06:07:53 -0400
commit55b8a545c389241fd4a8c3ef5f07ab7005ad4e74 (patch)
tree359416ebba37b84676e1a67fdc84671ce07dcce1 /INSTALL.markdown
parent83278c9c6df93dc43ee112bf1f57a03f25c92baa (diff)
Documentation changes, splitting information to multiple pages
Diffstat (limited to 'INSTALL.markdown')
-rw-r--r--INSTALL.markdown32
1 files changed, 32 insertions, 0 deletions
diff --git a/INSTALL.markdown b/INSTALL.markdown
new file mode 100644
index 0000000..14adb34
--- /dev/null
+++ b/INSTALL.markdown
@@ -0,0 +1,32 @@
+# q - Treating Text as a Database
+
+## Requirements
+* 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.
+
+ __**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`
+
+ **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
+
+
+ __**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`
+
+ **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.
+
+**NOTE:** If you're using Python 2.4, then you will have to install the sqlite3 package for q to work.
+
+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
+