Sync with GitBook (#120)

jamesbayley · Apr 29, 2024 · 6128246 · 6128246
1 parent b043263
commit 6128246
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 1 deletion.
diff --git a/.gitbook.yml b/.gitbook.yml
@@ -0,0 +1,5 @@
+root: ./docs
+
+structure:
+  readme: README.md
+  summary: SUMMARY.md
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <div align="center">
   <h1>Gazelle</h1>
-  <p>A fast, cross-platform engine for structural analysis & design.</p>
+  <p>The .NET SDK for Civil Engineers.</p>
 
   [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/gazellekit/gazelle)
   [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](https://github.com/gazellekit/gazelle/blob/main/.github/CODE_OF_CONDUCT.md)

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,15 @@
+---
+description: The .NET SDK for Civil Engineers.
+---
+
+# Welcome
+
+This is Gazelle Kit.
+
+We're an open-source, community-led project looking to: 
+
+- Accelerate AEC innovation, 
+- Underpin academic research, and 
+- Support Civil & Structural Engineering education. 
+
+Let's get started!
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -0,0 +1,3 @@
+# Table of contents
+
+* [Welcome](README.md)