architecture.md wip

Author: nikitabobko

Sources/AppBundle/tree/layoutRecursive.swift renamed to Sources/AppBundle/layout/layoutRecursive.swift

@@ -0,0 +1,58 @@
+# Architecture
+
+## Definitions
+
+**SPM.** Swift package manager and Swift build tool. In other words, `swift` CLI tool
+
+## High level overview
+
+- `../Sources`.
+  All major AeroSpace source code. Managed by SPM
+- `../Sources/AppBundle/`.
+  AeroSpace.app server. Technically, it's a swift library that is exposed to `xcode-app-bundle-launcher`
+- `../Sources/Cli/`.
+  CLI client. CLI client is built purely using SPM, no Xcode involved (phew!)
+- `../Sources/Common/`.
+  Shared code between server and client. Mainly command line args parsing and util functions are shared.
+- `../xcode-app-bundle-launcher/`, `../project.yml`, and `../AeroSpace.xcodeproj/`.
+  Very small technical directories that define entry point for Xcode project.
+  Xcode projects are hard to manage without using the Xcode itself.
+
+  But since I edit the source code in Neovim, all code is pushed as much as possible to SPM "library" located in `../Sources/`.
+  SPM doesn't allow building macOS apps (aka "App Bundle"). SPM is only capable of defining libraries and building CLI apps.
+
+  Only few necessary entry point files are located in `../xcode-app-bundle-launcher`.
+  The Xcode project model is located in `../AeroSpace.xcodeproj/` and generated by "skeleton" in `../project.yml`
+- `../Sources/AppBundleTests`.
+  Tests
+- `../docs/`.
+  Documentation for site and man pages in Asciidoc format https://asciidoc.org/
+
+## Commands subsystem
+
+todo
+
+../Sources/AppBundle/command/
+../Sources/Common/cmdArgs/
+
+Command checklist:
+- [ ] Documentation in `../docs/aerospace-*` and `../docs/commands.adoc`
+  - [ ] Check that site looks alright `./.commands.html`
+  - [ ] Check that man page looks alright `./.man`
+- [ ] Shell completion `../args-grammar.txt`
+
+## TOML Config parse subsystem
+
+todo
+
+../Sources/AppBundle/config/
+
+## Tree Model subsystem
+
+todo
+
+../Sources/AppBundle/tree/
+
+## Layout subsystem
+
+../Sources/AppBundle/layout/