Selaa lähdekoodia

README.dev: add directory structure

Nathalie Furmento 8 vuotta sitten
vanhempi
commit
5fced62797
1 muutettua tiedostoa jossa 23 lisäystä ja 1 poistoa
  1. 23 1
      README.dev

+ 23 - 1
README.dev

@@ -1,7 +1,7 @@
 # StarPU --- Runtime system for heterogeneous multicore architectures.
 #
 # Copyright (C) 2009, 2010, 2011  Université de Bordeaux
-# Copyright (C) 2010, 2011  CNRS
+# Copyright (C) 2010, 2011, 2016  CNRS
 #
 # 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
@@ -17,11 +17,33 @@
 Contents
 ========
 
+- Directory structure
 - Developer Warnings
 - Naming Conventions
 - Coding Style
 - Error handling
 
+Directory structure
+-------------------
+
+The directory structure is as follows:
+- src        : internal source for StarPU
+- include    : public API
+- tests      : unitary tests
+- examples   : examples using StarPU
+- doc        : documentation for StarPU
+
+StarPU extensions have their own directory (src/include/tests/examples) structure:
+
+- mpi           : The MPI support
+- socl          : the StarPU OpenCL-compatible interface
+- gcc-plugin    : the GCC plug-in that extends the C programming language with pragmas and attributes
+- sc_hypervisor : The Scheduling Context Hypervisor
+- starpufft     : The FFT support
+- starpu-top    : StarPU-Top Interface
+
+
+
 Developer Warnings
 ------------------