From c983865fc50b5aea7b494cdb268cbb979f96fa44 Mon Sep 17 00:00:00 2001 From: Chris McComb Date: Sun, 26 Nov 2023 14:22:39 -0500 Subject: [PATCH] Updating documentation --- README.md | 3 +- docs/_config.yml | 3 -- docs/_layouts/default.html | 64 -------------------------------------- docs/index.md | 13 -------- 4 files changed, 2 insertions(+), 81 deletions(-) delete mode 100644 docs/_config.yml delete mode 100644 docs/_layouts/default.html delete mode 100644 docs/index.md diff --git a/README.md b/README.md index 2281b92..edcb559 100644 --- a/README.md +++ b/README.md @@ -1 +1,2 @@ -See [the docs](https://thredgroup.github.io/TrussMe/) for more information. +# trussme +A simple truss solver written in Python. \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 45c081c..0000000 --- a/docs/_config.yml +++ /dev/null @@ -1,3 +0,0 @@ -theme: jekyll-theme-slate -show_downloads: true -show_forkme: true diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html deleted file mode 100644 index 3c4ed0c..0000000 --- a/docs/_layouts/default.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - -{% seo %} - - - - - -
-
- {% if site.show_forkme %} - View on GitHub - {% endif %} - -

THRED: {{ site.title | default: site.github.repository_name }}

-

{{ site.description | default: site.github.project_tagline }}

- - {% if site.show_downloads %} -
- Download this project as a .zip file - Download this project as a tar.gz file -
- {% endif %} -
-
- - -
-
- {{ content }} -
-
- - - - - {% if site.google_analytics %} - - {% endif %} - - diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 6558549..0000000 --- a/docs/index.md +++ /dev/null @@ -1,13 +0,0 @@ -**Contributors:** {% for member in site.github.contributors %}{% endfor %} - -## Introduction -Provides basic construction and analysis capabilities for trusses. - -## Construction -Add joints and members, and vary the material and cross-section of specific members in the truss. There is also an option to create truss from .trs file - -## Analysis -Calculate mass, forces, and the factor of safety (FOS) against buckling and yielding. Create a truss analysis report that provides approximate design recommendations - -### Acknowledgements -Force calculations based on a MATLAB function by [Hossein Rahami](http://www.mathworks.com/matlabcentral/fileexchange/authors/27559).