Readmes for examples, lib, generate, lifecycleScripts

mohseenrm · mohseenrm · commit f7cfe3277d91 · 2017-08-09T17:05:23.000-07:00
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,4 @@
+## /examples
+
+  List of examples of using NodeGit to implement common git core operations.
+
diff --git a/generate/README.md b/generate/README.md
@@ -0,0 +1,21 @@
+## Generate
+
+The scripts and templates in this dir, help generate the source code and tests for NodeGit. The major components of generate are:
+
+  1. Input
+  2. Scripts
+  3. Templates
+
+### Input
+
+  All the **configuration** required for the parser to generate the source code and tests. For more details, check the Input directory.
+
+### Scripts
+
+  The scripts that generate the final configuration (*snapshot of the library*) `idefs.json`, `missing-tests.json`. These configurations are then used to generate `src` for the library.
+
+### Templates
+
+  All the Combyne templates are placed here. The filters, partials, templates all help NodeGit generate the source code.
+
+// TODO: link to combyne, tutorial and docs.
diff --git a/lib/README.md b/lib/README.md
@@ -0,0 +1,3 @@
+## /lib
+
+  Contains wrappers to abstract the internals of the JS part of NodeGit Module.
diff --git a/lifecycleScripts/README.md b/lifecycleScripts/README.md
@@ -0,0 +1,5 @@
+## /lifecycleScripts
+
+  These scripts are responsible for downloading the right dependencies, configuring vendors, and all other dependencies that are required to build, generate and clean the module.
+
+  

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +## /examples
++
 +  List of examples of using NodeGit to implement common git core operations.
++
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## /lib`
	`2`	`+`
	`3`	`+ Contains wrappers to abstract the internals of the JS part of NodeGit Module.`