Permalink
Browse files

Updated README

  • Loading branch information...
1 parent e0fe4af commit 2dfca4498f2403c5be2dfe5b3ae14e53adcaeba0 @cderoove committed Aug 14, 2012
Showing with 66 additions and 9 deletions.
  1. +4 −0 .gitignore
  2. +2 −0 EkekoFeature/.gitignore
  3. +5 −0 EkekoFeature/README.md
  4. +2 −0 EkekoPlugin/.gitignore
  5. +43 −9 EkekoPlugin/README.md
  6. +10 −0 README.md
View
@@ -0,0 +1,4 @@
+.DS_Store
+.settings
+bin
+.metadata
View
@@ -1,2 +1,4 @@
+.DS_Store
+.settings
bin
.metadata
View
@@ -0,0 +1,5 @@
+# damp.ekeko.EkekoFeature
+
+Eclipse feature accompanying the actual Eclipse Plugin [damp.ekeko.EkekoPlugin](https://github.com/cderoove/damp.ekeko/tree/master/EkekoPlugin) for applicative logic meta-programming using Clojure's [core.logic](https://github.com/clojure/core.logic/) against an Eclipse workspace.
+
+See [README.md](https://github.com/cderoove/damp.ekeko/blob/master/EkekoPlugin/README.md) of [EclipsePlugin](https://github.com/cderoove/damp.ekeko/tree/master/EkekoPlugin) for more information.
View
@@ -1,2 +1,4 @@
+.DS_Store
+.settings
bin
.metadata
View
@@ -1,20 +1,54 @@
-# Ekeko
+# damp.ekeko.EkekoPlugin
Ekeko enables querying and manipulating an Eclipse workspace using applicative logic programs.
-Its libraries provide support for answering program queries (e.g., "is my code bug free?" or "does my code follow the prescribed design?") as well as transforming programs (e.g., "patch my code as follows") in a declarative manner.
+Its libraries provide support for answering program queries (e.g., "*is my code bug free?*" or "*does my code follow the prescribed design?*") as well as transforming programs (e.g., "*patch my code as follows*") in a declarative manner.
-Ekeko is based on the core.logic (https://github.com/clojure/core.logic) port to Clojure (http://clojure.org/) of the declarative applicative programming language Kanren (http://kanren.sourceforge.net/).
+Ekeko is based on the excellent [core.logic](https://github.com/clojure/core.logic) port to [Clojure](http://clojure.org/) of the applicative logic programming library [Kanren](http://kanren.sourceforge.net/).
-Ekeko is meant as the successor to the SOUL logic program query language (http://soft.vub.ac.be/SOUL/), which still hosts links to academic papers about logic program querying.
+Ekeko is meant as the successor to the [SOUL logic program query language](http://soft.vub.ac.be/SOUL/), which still hosts academic papers about logic program querying.
-## Usage
+## Installation
-Build or install the Eclipse plugin.
+Install the prebuilt Ekeko plugin from the Eclipse update site:
+[http://soft.vub.ac.be/eclipse/update-3.7/](http://soft.vub.ac.be/eclipse/update-3.7/)
-## License
+Ekeko has been tested against [Eclipse Juno (4.2)](http://www.eclipse.org)
-Copyright © 2012 Coen De Roover (damp.ekeko*), Carlos Noguera (barista*)
+Plugin dependencies [org.eclipse.jdt.astview](http://www.eclipse.org/jdt/ui/astview/index.php) and [Counterclockwise](http://code.google.com/p/counterclockwise/) should be installed automatically.
-Distributed under the Eclipse Public License, the same as Clojure.
+Alternatively, the plugin can also be built from [EclipsePlugin](https://github.com/cderoove/damp.ekeko/tree/master/EkekoPlugin) and its feature from [EclipseFeature](https://github.com/cderoove/damp.ekeko/tree/master/EkekoFeature) using the Eclipse export wizards on the [plugin.xml](https://github.com/cderoove/damp.ekeko/blob/master/EkekoPlugin/plugin.xml) and [feature.xml](https://github.com/cderoove/damp.ekeko/blob/master/EkekoFeature/feature.xml) files from the respective Eclipse projects.
+
+## Documentation
+
+
+
+## License
+
+Copyright © 2012 Ekeko contributors:
+
+* [Coen De Roover](http://soft.vub.ac.be/~cderoove/): initial design, implementation and documentation
+
+* [Carlos Noguera](http://soft.vub.ac.be/soft/members/carlosnoguera): Barista graphical [user interface](http://soft.vub.ac.be/SOUL/home/querying-from-eclipse/running-and-inspecting-a-query/)
+
+* [Reinout Stevens](http://soft.vub.ac.be/soft/members/reinoutstevens): damp.ekeko.workspace.reification
+
+Distributed under the Eclipse Public License.
+
+Ekeko stands on the shoulders of open source giants.
+Included dependencies:
+
+* Clojure's applicative logic programming library [core.logic](https://github.com/clojure/core.logic/) (Eclipse Public License)
+* [Reinout Stevens](http://soft.vub.ac.be/soft/members/reinoutstevens)' regular path expression library [damp.qwal](https://github.com/ReinoutStevens/damp.qwal
+) (Eclipse Public License)
+* Anders Hessellund's intra-procedural JDT control flow graph [dk.itu.smartemf.ofbiz.analysis.ControlFlowGraph](http://www.itu.dk/people/hessellund/smartemf/index.php
+) (Apache license)
+* Sable's Java Optimization Framework [Soot](http://www.sable.mcgill.ca/soot/
+) (LGPL)
+
+External dependencies:
+
+* Eclipse plugin [org.eclipse.jdt.astview](http://www.eclipse.org/jdt/ui/astview/index.php) (Eclipse Public License)
+* Eclipse plugin [Counterclockwise](http://code.google.com/p/counterclockwise/
+) (Eclipse Public License)
View
@@ -0,0 +1,10 @@
+# damp.ekeko
+
+Applicative logic meta-programming using Clojure's [core.logic](https://github.com/clojure/core.logic/) against an Eclipse workspace.
+
+Overview:
+
+* [EclipsePlugin](https://github.com/cderoove/damp.ekeko/tree/master/EkekoPlugin) the actual Eclipse plugin
+* [EclipseFeature](https://github.com/cderoove/damp.ekeko/tree/master/EkekoFeature) its accompanying Eclipse feature
+
+See [README.md](https://github.com/cderoove/damp.ekeko/blob/master/EkekoPlugin/README.md) of [EclipsePlugin](https://github.com/cderoove/damp.ekeko/tree/master/EkekoPlugin) for more information.

0 comments on commit 2dfca44

Please sign in to comment.