From 8346fb5dbb9d70ccb45c36ae14a744224ab9b0c9 Mon Sep 17 00:00:00 2001 From: Mohamed Ibrahim <mibrahim@mibrahim.net> Date: Sun, 27 Sep 2015 11:49:25 -0400 Subject: [PATCH] Adding developers guide --- doc/DevelopersGuide.md.md | 29 +++++++++++++++++++++++++++++ doc/README.md | 2 +- 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 doc/DevelopersGuide.md.md diff --git a/doc/DevelopersGuide.md.md b/doc/DevelopersGuide.md.md new file mode 100644 index 00000000..350226f8 --- /dev/null +++ b/doc/DevelopersGuide.md.md @@ -0,0 +1,29 @@ +#DevelopersGuide +*Aparapi developers guide. Updated Sep 13, 2011 by frost.g...@gmail.com* +##Developer Guide +Although the vast majority of the Aparapi code is Java® we do include some to C++ code (accessed from Java™ via JNI) to interface with existing OpenCL™ C/C++ headers and libraries. Therefore to build Aparapi for a given platform (Microsoft® Windows® 32- or 64- bit and or Linux® 32- or 64- bit) we do require developers to setup a build environment containing both Java® and C++ development tools. In this documentation we will describe the tools required to build Aparapi for the various supported platforms. + +##Supported Platforms +In general Aparapi can be used on any platform currently supported by AMD APP SDK v2.5 or later. Please check the AMD APP SDK site for details on supported platforms and installation help. + +[http://developer.amd.com/sdks/amdappsdk/downloads/pages/default.aspx](http://developer.amd.com/sdks/amdappsdk/downloads/pages/default.aspx) + +[http://developer.amd.com/sdks/AMDAPPSDK/assets/AMD_APP_SDK_Installation_Notes.pdf](http://developer.amd.com/sdks/amdappsdk/downloads/pages/default.aspx) + +* 32-bit Microsoft® Windows® 7 +* 32-bit Microsoft® Windows Vista® +* 64-bit Microsoft® Windows® 7 +* 64-bit Microsoft® Windows Vista® +* 32-bit Linux® +* 64-bit Linux® + +Clearly we will also depend on platform specific Oracle® Java® JDK 6 components and C++ compilers along with some platform neutral tools (such as SVN, ant and Junit) . + +## Platform Specific Developer Guides +We have broken the Developer Guide into two separate docs. One for Linux® (32- and 64- bit) and another for Microsoft® Windows® (32- and 64- bit). Please follow the appropriate link below. + +[DevelopersGuideLinux](DevelopersGuideLinux.md) + +[DevelopersGuideWindows](DevelopersGuideWindows.md) + +Attribution \ No newline at end of file diff --git a/doc/README.md b/doc/README.md index b03ec273..0dd3c0f2 100644 --- a/doc/README.md +++ b/doc/README.md @@ -40,7 +40,7 @@ APARAPI Documentation | [UnitTestGuide](UnitTestGuide.md) | Unit test Guide Find out how to run Junit tests and how to add new tests. | | [NewFeatures](NewFeatures.md) | New Features added to this open source release of Aparapi. | | [UsersGuide](UsersGuide.md) | Aparapi User's Guide. | -| DevelopersGuide | Aparapi developers guide. | +| [DevelopersGuide](DevelopersGuide.md) | Aparapi developers guide. | | ContributionGuide | How to contribute (bug fix or features). | | JavaKernelGuidelines | What code can and can't be converted to OpenCL by Aparapi. | | [Attribution](Attribution.md) | Attribution | -- GitLab