Sfoglia il codice sorgente

HPCC-17902 Provide links to the existing developer documentation

Signed-off-by: Gavin Halliday <gavin.halliday@lexisnexis.com>
Gavin Halliday 8 anni fa
parent
commit
182f776ef3
1 ha cambiato i file con 11 aggiunte e 0 eliminazioni
  1. 11 0
      README.md

+ 11 - 0
README.md

@@ -61,3 +61,14 @@ ESP (Enterprise Services Platform) provides an easy to use interface to access E
 
 * Standards-based interface to access ECL functions
 
+# Developer documentation
+
+The following links describe the structure of the system and detail some of the key components:
+
+* [An overview of workunits and the different stages in executing a query](https://github.com/hpcc-systems/HPCC-Platform/blob/master/ecl/eclcc/WORKUNITS.rst)
+* [An introduction to the code generator - eclcc](https://github.com/hpcc-systems/HPCC-Platform/blob/master/ecl/eclcc/DOCUMENTATION.rst)
+* [The memory manager used by roxie and thor](https://github.com/hpcc-systems/HPCC-Platform/blob/master/roxie/roxiemem/DOCUMENTATION.rst)
+* [The structure of the initialization scripts](https://github.com/hpcc-systems/HPCC-Platform/blob/master/initfiles/DOCUMENTATION.rst)
+* [Outline of ecl-bundle](https://github.com/hpcc-systems/HPCC-Platform/blob/master/ecl/ecl-bundle/DOCUMENTATION.rst)
+* [The structure and some details of the cmake files](https://github.com/hpcc-systems/HPCC-Platform/blob/master/cmake_modules/DOCUMENTATION.rst)
+* [Building the documentation](https://github.com/hpcc-systems/HPCC-Platform/blob/master/docs/DOCUMENTATION.rst)