Merge branch 'main' into feature/newparse-full

.github/workflows/github-actions-pages.yml

@@ -0,0 +1,37 @@
+name: Build Docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install Docket
+      run: cargo install docket --no-default-features --features syntect-hl 
+    - name: Run Docket
+      run: docket -s docs -t _site
+    - name: Push artifact
+      uses: actions/upload-pages-artifact@v0
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -24,3 +24,5 @@ bin/
 
 # TODO file
 TODO.md
+
+docs-rendered

CNAME

@@ -0,0 +1 @@
+docs.feersum-scheme.net

README.md

@@ -2,7 +2,7 @@
 <p align="center">
 	<img src="docs/Logo_colour_sm.png" alt="Ant in a box"  />
 </p>
-<h1 align="center">Feersum Scheme</h1>
+<h1 align="center"><samp>(feersum . scheme)</samp></h1>
 <p align="center">
 <a href=https://dev.azure.com/iwillspeak/GitHub/_build/latest?definitionId=4&branchName=main"><img alt="Build Status" src="https://dev.azure.com/iwillspeak/GitHub/_apis/build/status/iwillspeak.feersum?branchName=main" /></a>
 <a href="https://www.fuget.org/packages/Feersum"><img alt="Feersum on fuget.org" src="https://www.fuget.org/packages/Feersum/badge.svg" /></a>

docs/01-getting-started.md

@@ -0,0 +1,31 @@
+# Getting Started with Feersum Scheme
+
+The Feersum scheme compiler is available as a .NET tool. Install it globally
+with `dotnet tool install -g Feersum`. Once installed it should be available
+on the command line as `feersum-scheme`. You can alais this to `scheme` if you
+are brave enough to use Feersum as your _default_ scheme implementation.
+
+Once you have the tool installed you can access a Scheme Read, Eval, Print, Loop
+(REPL) by running `feersum-scheme`. You can then type in scheme expressions to
+be evaluated and see their representation printed back to you:
+
+```
+Feersum Scheme Compiler - 0.2.5
+§> "Hello, Schemer!"
+}= "Hello, Schemer!"
+§> (+ 1 9)  
+}= 10
+§> 
+```
+
+> note, current limitations preven REPL expressions from accessing the results
+> of previous expressions. Each expression must be a complete Scheme fomr on a
+> single line.
+>
+> Check out <https://github.com/iwillspeak/feersum/issues/35> to track progress
+> on interactive scripting.
+
+## SDK Projects
+
+Feersum scheme is also available as a .NET SDK. See the [Examples](/examples/) for
+more information.

docs/02-examples.md

@@ -0,0 +1,7 @@
+# Example SDK Projects
+
+Feersum scheme can be used to build console tools or class libraries. The
+Feersum .NET SDK is distributed as a NuGet package. Check out [the `examples/`
+folder][example-projects] for more information.
+
+[example-projects]: https://github.com/iwillspeak/feersum/blob/main/examples/