From 0ce51364533629903e4e7ed3633d8cc85ca0c56c Mon Sep 17 00:00:00 2001 From: Alcides Fonseca Date: Tue, 23 Oct 2012 23:49:58 +0100 Subject: [PATCH] Improved Readme. --- Readme.txt | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/Readme.txt b/Readme.txt index 43409e3..82df34a 100644 --- a/Readme.txt +++ b/Readme.txt @@ -1,5 +1,31 @@ AeminiumGPU Compiler -Compiler from Java to Java with OpenCL, in order to take advantage of the AeminiumGPU Runtime. +This is a Java Source to Source compiler that located special lambda functions and translates +them to OpenCL. The generated code will be able to be automatically executed on the GPU by the +AeminiumGPU runtime (http://github.com/AEminium/AeminiumGPU/), where the API is defined. +The compiler uses the Spoon Compiler Toolkit (http://spoon.gforge.inria.fr/). -This is part of the Aeminium Language (http://code.google.com/p/aeminium) and focus of the master thesis of Alcides Fonseca (http://alcidesfonseca.com) \ No newline at end of file +This is part of the Æminium Project (http://aeminium.dei.uc.pt) + +Author: +Alcides Fonseca + +How to execute: + +1) Clone (or download) the project. +2) Make sure the AeminiumGPU project is at the same level as this one. +3) Add your Java code to the src folder. +4) Define the main-class in the build.xml file. +5) Execute `ant run` + + +Source Code Organization: + +bin: User class files. +compiler: Compiler class files (bin for the compiler). +compiler-lib: Java libraries required for compiling the compiler. +compiler-src: Source for the Compiler +lib: User Java Libraries +spooned: Java Code generated by the compiler for the src directory. +src: User Java Code. +utils: Miscellaneous code. \ No newline at end of file