瀏覽代碼

Merge pull request #10167 from ghalliday/issue17902

HPCC-17902 Provide links to the existing developer documentation

Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>
Richard Chapman 8 年之前
父節點
當前提交
8f7cdc8a00
共有 1 個文件被更改,包括 11 次插入0 次删除
  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)