From a04ddf72ee3052a73fe25962772ae0cbaf9b7c51 Mon Sep 17 00:00:00 2001 From: Salvo 'LtWorf' Tomaselli Date: Wed, 11 Feb 2015 16:56:21 +0100 Subject: [PATCH] better readme --- README | 10 ---------- README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 10 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index b919019..0000000 --- a/README +++ /dev/null @@ -1,10 +0,0 @@ -To launch the application, run - -./relational_gui.py - -Language definition is here: -https://github.com/ltworf/relational/wiki/Grammar-and-language - -If it needs some dependencies: -Qt4, Python 2.7, either PyQT4 or Pyside. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..d629330 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +Relational an educational tool to provide a workspace for experimenting with *relational* *algebra*, an offshoot of first-order logic. + +It provides GUI that can be used for executing relational queries, and also provides a command line interface. + +Provides a standalone Python module that can be used for executing relational queries, parsing relational expressions and optimizing them. + +Install +======= + +Windows installer can be found here: https://code.google.com/p/relational/downloads/list + +For Linux, check your distribution's packages, relational is available on Debian and Ubuntu. + + +Usage +===== + +Formal language definition at this link https://github.com/ltworf/relational/wiki/Grammar-and-language + + + +Run from sources +================ + + +To launch the application, run + +```./relational_gui.py``` + +If it needs some dependencies: +Qt4, Python 2.7, either PyQT4 or Pyside. + +It can run on osx but this is not supported. +