diff --git a/README.md b/README.md index b89d4e0..f4f1027 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@
-

Gazelle

A fast, cross-platform engine for structural analysis & design.

[![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/CODE_OF_CONDUCT.md) + [![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) [![CI](https://github.com/gazellekit/gazelle/actions/workflows/ci.yml/badge.svg)](https://github.com/gazellekit/gazelle/actions/workflows/ci.yml) [![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-00add8)](https://choosealicense.com/licenses/agpl-3.0/) @@ -14,25 +13,22 @@ ## Table of Contents -- [Overview](#overview) -- [Supported Platforms](#supported-platforms) +- [Project Goals](#project-goals) - [Documentation](#documentation) -- [Why F#?](#why-f) +- [Supported Platforms](#supported-platforms) - [Open Source](#open-source) - [Contributing](#contributing) -- [Community](#community) - [Errata](#errata) -## Overview +## Project Goals -Gazelle aspires to: +- Underpin academic research. +- Accelerate AEC software innovation. +- Support civil and structural engineering education. -1. Underpin academic research. -2. Support Structural Engineering education. -3. Accelerate AEC software innovation. -4. Become an authoritative *source of truth*. -5. Offer first-class support for [Polyglot Notebooks](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode). -6. Demonstrate that F# is ideal for Civil Engineers. +## Documentation + +Please visit [docs.gazelle.sh](https://docs.gazelle.sh) to learn more. ## Supported Platforms @@ -47,29 +43,6 @@ Gazelle runs everywhere that [.NET](https://dotnet.microsoft.com/en-us/learn/dot - WASM - And more... -In fact, the project is actively developed on Ubuntu Linux running inside of [GitHub Codespaces](https://github.com/features/codespaces). - -## Documentation - -Please visit [docs.gazelle.sh](https://docs.gazelle.sh) to learn more. - -## Why F#? - -

- Many programming languages were considered before committing to F#. Whilst the community of F# developers is smaller than for C#, Python, JavaScript, Rust etc. the language offers a number of distinct features that make it ideal for Civil & Structural Engineering software. -

- -1. **Runs on .NET:** this makes it fast, extremely portable and fully interoperable with C#. -2. **Polyglot Notebooks:** F# has great support for Polyglot Notebooks in VSCode. Check out our [examples](./examples/). -3. **Functional-first:** the FP paradigm allows for succinct, maintainable, elegant solutions. -4. **Units-of-Measure:** mathematical unit systems (e.g., Metres, Newtons) can be [encoded and checked at compile time](https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/units-of-measure)! -5. **Great for Cloud:** REST API services are stateless by definition; the Functional Programming paradigm mirrors this nicely. -6. **ML type system:** it's very strict and if your code *builds* then it probably runs too! - -For some, the choice of F# will be an odd one. However, we believe it's perfect for solving our domain problems. We also really enjoy working with the language and want to see it more widely adopted. - -> One who takes the road less traveled earns the rewards most missed. - Matshona Dhliwayo - ## Open Source

@@ -95,31 +68,6 @@ For some, the choice of F# will be an odd one. However, we believe it's perfect - Enhance our testing and performance suite, - Verify algorithmic correctness. -## Community - -

- For those keen to build upon the core Gazelle engine and extend its reach and capabilities, here are a few suggested project ideas: -

- -- Organise local meetups to discuss how Gazelle could enhance your existing workflows, -- Plan conferences and community engagement events to broaden Gazelle's adoption, -- Install the Gazelle NuGet package and run it inside Polyglot Notebooks. - -```fsharp -// Polyglot Notebooks sample. - -// Install package from NuGet Package Gallery. -#r "nuget: Gazelle" - - -open Gazelle.Units - -let moment = 2.5 -let force = 5.0 - -printfn $"Moment / Force = %.2f{moment / force} m" // => 0.50 m -``` - ## Errata