From ecdeecc111e1ee5b375c3d5400f7621ad9e40519 Mon Sep 17 00:00:00 2001 From: Kunle Yusuf <89423261+kunle009@users.noreply.github.com> Date: Sat, 18 May 2024 16:17:43 +0100 Subject: [PATCH] "Updated README.md to add links to package documentation and examples" --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb7b1630..d2b35176 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,10 @@ This module will be useful in determining: The project is based mainly on instructions contained in the Eurocode 2 alongside python packages like numpy,plotly,scipy and IndeterminateBeam package. Comprehensive -examples are contained in the examples folder +examples are contained in the examples folder. +The full package documentation can be accessed [here](http://foundationdesign.readthedocs.io/). + +Text-based examples of the package presented in the [documentation](http://foundationdesign.readthedocs.io/examples.html) the following examples have been treated thus far [Concentric Pad Foundation](https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Concentric_Footing_Example.ipynb), [Eccentric Pad Foundation](https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Eccentric_Footing_Example.ipynb) and a [Combined Footing Pad Foundation](https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Combined_Footing_Mosley_bungey.ipynb). A web-based graphical user interface (GUI) is currently in development. ## Project Purpose