Browse Source

move section 'Running StarPU Applications on Microsoft Visual C' from INSTALL to README and also copy section in doxygen documentation

Nathalie Furmento 11 years ago
parent
commit
70f5cbc89d
3 changed files with 91 additions and 52 deletions
  1. 0 39
      INSTALL
  2. 50 13
      README
  3. 41 0
      doc/doxygen/chapters/01building.doxy

+ 0 - 39
INSTALL

@@ -19,7 +19,6 @@ Contents
 
 
 * Installing StarPU on a Unix machine
 * Installing StarPU on a Unix machine
 * Installing StarPU on Windows
 * Installing StarPU on Windows
-* Running StarPU Applications on Microsoft Visual C
 
 
 
 
 
 
@@ -214,41 +213,3 @@ autogen.sh part.
    and set the StarPU bin directory in your path.
    and set the StarPU bin directory in your path.
 
 
    export PATH=<StarPU installation directory>/bin:$PATH
    export PATH=<StarPU installation directory>/bin:$PATH
-
-
-Running StarPU Applications on Microsoft Visual C
--------------------------------------------------
-
-Batch files are provided to run StarPU applications under Microsoft
-Visual C. They are installed in path_to_starpu/bin/msvc.
-
-To execute a StarPU application, you first need to set the environment
-variable STARPU_PATH.
-
-c:\....> cd c:\cygwin\home\ci\starpu\
-c:\....> set STARPU_PATH=c:\cygwin\home\ci\starpu\
-c:\....> cd bin\msvc
-c:\....> starpu_open.bat starpu_simple.c
-
-The batch script will run Microsoft Visual C with a basic project file
-to run the given application.
-
-The batch script starpu_clean.bat can be used to delete all
-compilation generated files.
-
-The batch script starpu_exec.bat can be used to compile and execute a
-StarPU application from the command prompt.
-
-c:\....> cd c:\cygwin\home\ci\starpu\
-c:\....> set STARPU_PATH=c:\cygwin\home\ci\starpu\
-c:\....> cd bin\msvc
-c:\....> starpu_exec.bat ..\..\..\..\examples\basic_examples\hello_world.c
-
-MSVC StarPU Execution
-...
-/out:hello_world.exe
-...
-Hello world (params = {1, 2.00000})
-Callback function got argument 0000042
-c:\....>
-

+ 50 - 13
README

@@ -1,7 +1,7 @@
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 #
 #
 # Copyright (C) 2009-2012  Université de Bordeaux 1
 # Copyright (C) 2009-2012  Université de Bordeaux 1
-# Copyright (C) 2010, 2011, 2013  Centre National de la Recherche Scientifique
+# Copyright (C) 2010, 2011, 2013, 2014  Centre National de la Recherche Scientifique
 #
 #
 # StarPU is free software; you can redistribute it and/or modify
 # StarPU is free software; you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
 # it under the terms of the GNU Lesser General Public License as published by
@@ -128,9 +128,46 @@ StarPU to hang or exhibit incorrect behaviour.
 
 
 For details on the Windows build process, see the INSTALL file.
 For details on the Windows build process, see the INSTALL file.
 
 
-++==================++
-|| V. Documentation ||
-++==================++
+++======================================================++
+|| V. Running StarPU Applications on Microsoft Visual C ||
+++======================================================++
+
+Batch files are provided to run StarPU applications under Microsoft
+Visual C. They are installed in path_to_starpu/bin/msvc.
+
+To execute a StarPU application, you first need to set the environment
+variable STARPU_PATH.
+
+c:\....> cd c:\cygwin\home\ci\starpu\
+c:\....> set STARPU_PATH=c:\cygwin\home\ci\starpu\
+c:\....> cd bin\msvc
+c:\....> starpu_open.bat starpu_simple.c
+
+The batch script will run Microsoft Visual C with a basic project file
+to run the given application.
+
+The batch script starpu_clean.bat can be used to delete all
+compilation generated files.
+
+The batch script starpu_exec.bat can be used to compile and execute a
+StarPU application from the command prompt.
+
+c:\....> cd c:\cygwin\home\ci\starpu\
+c:\....> set STARPU_PATH=c:\cygwin\home\ci\starpu\
+c:\....> cd bin\msvc
+c:\....> starpu_exec.bat ..\..\..\..\examples\basic_examples\hello_world.c
+
+MSVC StarPU Execution
+...
+/out:hello_world.exe
+...
+Hello world (params = {1, 2.00000})
+Callback function got argument 0000042
+c:\....>
+
+++===================++
+|| VI. Documentation ||
+++===================++
 
 
 Texinfo documentation is available in doc/ . If LaTeX is available on the
 Texinfo documentation is available in doc/ . If LaTeX is available on the
 machine, a pdf can be generated by running
 machine, a pdf can be generated by running
@@ -141,22 +178,22 @@ If makeinfo is available on the machine, html pages can be generated by running
 
 
   $ make -C doc html
   $ make -C doc html
 
 
-++============++
-|| VI. Trying ||
-++============++
+++=============++
+|| VII. Trying ||
+++=============++
 
 
 Some examples ready to run are installed into $prefix/lib/starpu/{examples,mpi}
 Some examples ready to run are installed into $prefix/lib/starpu/{examples,mpi}
 
 
-++==============++
-|| VII. Upgrade ||
-++==============++
+++===============++
+|| VIII. Upgrade ||
+++===============++
 
 
 To upgrade your source code from older version (there were quite a few
 To upgrade your source code from older version (there were quite a few
 renamings), use the tools/dev/rename.sh script
 renamings), use the tools/dev/rename.sh script
 
 
-++===============++
-|| VIII. Contact ||
-++===============++
+++=============++
+|| IX. Contact ||
+++=============++
 
 
 For any questions regarding StarPU, please contact the starpu-devel
 For any questions regarding StarPU, please contact the starpu-devel
 mailing-list at starpu-devel@lists.gforge.inria.fr .
 mailing-list at starpu-devel@lists.gforge.inria.fr .

+ 41 - 0
doc/doxygen/chapters/01building.doxy

@@ -212,6 +212,47 @@ Please note that buses are benchmarked when StarPU is launched for the
 first time. This may take a few minutes, or less if <c>hwloc</c> is
 first time. This may take a few minutes, or less if <c>hwloc</c> is
 installed. This step is done only once per user and per machine.
 installed. This step is done only once per user and per machine.
 
 
+\subsection RunningABasicStarPUApplicationOnMicrosoft Running a Basic StarPU Application on Microsoft Visual C
+
+Batch files are provided to run StarPU applications under Microsoft
+Visual C. They are installed in <c>$STARPU_PATH/bin/msvc</c>.
+
+To execute a StarPU application, you first need to set the environment
+variable <c>STARPU_PATH</c>.
+
+\verbatim
+c:\....> cd c:\cygwin\home\ci\starpu\
+c:\....> set STARPU_PATH=c:\cygwin\home\ci\starpu\
+c:\....> cd bin\msvc
+c:\....> starpu_open.bat starpu_simple.c
+\endverbatim
+
+The batch script will run Microsoft Visual C with a basic project file
+to run the given application.
+
+The batch script <c>starpu_clean.bat</c> can be used to delete all
+compilation generated files.
+
+The batch script <c>starpu_exec.bat</c> can be used to compile and execute a
+StarPU application from the command prompt.
+
+\verbatim
+c:\....> cd c:\cygwin\home\ci\starpu\
+c:\....> set STARPU_PATH=c:\cygwin\home\ci\starpu\
+c:\....> cd bin\msvc
+c:\....> starpu_exec.bat ..\..\..\..\examples\basic_examples\hello_world.c
+\endverbatim
+
+\verbatim
+MSVC StarPU Execution
+...
+/out:hello_world.exe
+...
+Hello world (params = {1, 2.00000})
+Callback function got argument 0000042
+c:\....>
+\endverbatim
+
 \subsection KernelThreadsStartedByStarPU Kernel Threads Started by StarPU
 \subsection KernelThreadsStartedByStarPU Kernel Threads Started by StarPU
 
 
 StarPU automatically binds one thread per CPU core. It does not use
 StarPU automatically binds one thread per CPU core. It does not use