repo init. partial port of existing code

1 files changed, 20 insertions, 1 deletions

diff --git a/README.md b/README.md
index 14cf4c3..5f5b612 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,20 @@
-# celeritas-core
\ No newline at end of file
+# celeritas-core
+
+Not all files are fleshed out right now.
+
+**Work-in-progress**: porting over code from old repository.
+
+All third-party dependencies are licensed under their own license.
+
+## Notes
+
+* Check symbols in an 'archive' (static library)
+    * `nm -C build/libcore.a`
+
+* Generate compiler_commands.json
+    * `xmake project -k compile_commands`
+
+* Formatting
+    * `xmake format`
+    * Lint (no change) `find lib/core -iname *.h -o -iname *.c | xargs clang-format --style=file --dry-run --Werror`
+    * Format (edit in place) `find src -iname *.h -o -iname *.c | xargs clang-format -i --style=file`
\ No newline at end of file