initial commit, project layout notes

automerge · May 23, 2024 · f357916 · f357916
1 parent f107c3b
commit f357916
Show file tree

Hide file tree

Showing 3 changed files with 120 additions and 0 deletions.
diff --git a/notes/project-layers.md b/notes/project-layers.md
@@ -0,0 +1,8 @@
+# Project layers for Automerge-swift
+
+![Block diagram of the Automerge swift project layers](./project-layout.svg)
+
+The Automerge package intentionally holds no additional package dependencies, aside from the core Automerge library.
+In Automerge, conditionally compile for platform specific dependencies (for example, `Combine`, `SwiftUI`, `CoreTransferrable`, `UniformTypeIdentifiers`) so that the package compiles cleanly in WASM.
+This is "enforced" by a validation build that compiles the project using a Swift-WASM toolchain.
+
diff --git a/notes/project-layout.afdesign b/notes/project-layout.afdesign
diff --git a/notes/project-layout.svg b/notes/project-layout.svg