Merge pull request #2266 from rsteube/doc-project-layout

doc: added project layout

docs/src/SUMMARY.md

@@ -21,6 +21,7 @@
   - [Variable](./variable.md)
     - [Conditions](./variable/conditions.md)
   - [Development](./development.md)
+    - [Project Layout](./development/projectLayout.md)
     - [Build](./development/build.md)
     - [Docker](./development/docker.md)
     - [Creating completers](./development/creatingCompleters.md)

docs/src/development/projectLayout.md

@@ -0,0 +1,27 @@
+# Project Layout
+
+```sh
+.
+├── cmd
+│  ├── carapace # main application
+│  ├── carapace-fmt # simple formatter
+│  ├── carapace-generate # called by `go generate`
+│  ├── carapace-lint # simple linter
+│  ├── carapace-parse # simple help output parser
+│  └── carapace-shim # binary for runnable specs in windows
+├── completers # completers
+│  └── example_completer # completer for `example`
+│    └── cmd
+│      └── action # local (coupled) actions
+├── completers_release # optimized completers
+├── dist # goreleaser dist folder
+├── docs # documentation
+├── internal # some internal packages
+└── pkg # public packages
+   ├── actions # shared actions that are also exposed as macros
+   │  └── tools # shared actions specific to tools
+   ├── conditions # conditions for environment variable completion
+   ├── env # environment variables
+   ├── styles # style configurations
+   └── util # some util functions
+```