From 084d5a42a728de492404658b50a9f71e882743e4 Mon Sep 17 00:00:00 2001 From: Shawn Garbett Date: Wed, 19 Feb 2025 15:02:32 -0600 Subject: [PATCH 1/5] Updated README to include link to documentation --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 62fa341be..cc7664687 100644 --- a/README.md +++ b/README.md @@ -48,3 +48,9 @@ export PATH="$FRED_HOME/bin:${PATH}" export PATH="$FRED_HOME/pybin/bin:${PATH}" export FRED_GNUPLOT= #e.g. /opt/local/bin/gnuplot ``` + +#### Getting Started + +With a copy of FRED compiled, one is now ready to get started. Please see our +documentation: [Agent-Based Modeling with FRED](docs/Agent-Based%20Modeling%20with%20FRED.docx), +or the power point: [Structured FRED](docs/Structured%20FRED.pptm). From 6fb37db8eeeade9e535ce3f57af2bc6cf95ffe07 Mon Sep 17 00:00:00 2001 From: Shawn Garbett Date: Wed, 19 Feb 2025 15:05:47 -0600 Subject: [PATCH 2/5] Trying to make link downloadable and relative for README documentation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cc7664687..96662b312 100644 --- a/README.md +++ b/README.md @@ -52,5 +52,5 @@ export FRED_GNUPLOT= #e.g. /opt/local/bin/gnuplot #### Getting Started With a copy of FRED compiled, one is now ready to get started. Please see our -documentation: [Agent-Based Modeling with FRED](docs/Agent-Based%20Modeling%20with%20FRED.docx), -or the power point: [Structured FRED](docs/Structured%20FRED.pptm). +documentation: [Agent-Based Modeling with FRED](../raw/master/docs/Agent-Based%20Modeling%20with%20FRED.docx), +or the power point: [Structured FRED](../raw/master/docs/Structured%20FRED.pptm). From 910b2e4e423fa592f3bedc7db6367467bda8bf55 Mon Sep 17 00:00:00 2001 From: Shawn Garbett Date: Wed, 19 Feb 2025 15:07:00 -0600 Subject: [PATCH 3/5] Another guess at format --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96662b312..bed1d9c11 100644 --- a/README.md +++ b/README.md @@ -52,5 +52,5 @@ export FRED_GNUPLOT= #e.g. /opt/local/bin/gnuplot #### Getting Started With a copy of FRED compiled, one is now ready to get started. Please see our -documentation: [Agent-Based Modeling with FRED](../raw/master/docs/Agent-Based%20Modeling%20with%20FRED.docx), -or the power point: [Structured FRED](../raw/master/docs/Structured%20FRED.pptm). +documentation: [Agent-Based Modeling with FRED](raw/master/docs/Agent-Based%20Modeling%20with%20FRED.docx), +or the power point: [Structured FRED](raw/master/docs/Structured%20FRED.pptm). From 1507080cc9112da40d94f504c5a89891e8836cb8 Mon Sep 17 00:00:00 2001 From: Shawn Garbett Date: Wed, 19 Feb 2025 15:13:17 -0600 Subject: [PATCH 4/5] Cannot get relative raw link to work, going for direct to source link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bed1d9c11..014d138a2 100644 --- a/README.md +++ b/README.md @@ -52,5 +52,5 @@ export FRED_GNUPLOT= #e.g. /opt/local/bin/gnuplot #### Getting Started With a copy of FRED compiled, one is now ready to get started. Please see our -documentation: [Agent-Based Modeling with FRED](raw/master/docs/Agent-Based%20Modeling%20with%20FRED.docx), -or the power point: [Structured FRED](raw/master/docs/Structured%20FRED.pptm). +documentation: [Agent-Based Modeling with FRED](https://github.com/PublicHealthDynamicsLab/FRED/raw/refs/heads/FRED-v5.7.0/docs/Agent-Based%20Modeling%20with%20FRED.docx), +or the power point: [Structured FRED](https://github.com/PublicHealthDynamicsLab/FRED/raw/master/docs/Structured%20FRED.pptm). From fa93898ccf2c29cb404d486490e1ce7e14026387 Mon Sep 17 00:00:00 2001 From: Shawn Garbett Date: Wed, 19 Feb 2025 15:14:33 -0600 Subject: [PATCH 5/5] Links are unfortunately into a specific tag release --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 014d138a2..79b3d795e 100644 --- a/README.md +++ b/README.md @@ -53,4 +53,4 @@ export FRED_GNUPLOT= #e.g. /opt/local/bin/gnuplot With a copy of FRED compiled, one is now ready to get started. Please see our documentation: [Agent-Based Modeling with FRED](https://github.com/PublicHealthDynamicsLab/FRED/raw/refs/heads/FRED-v5.7.0/docs/Agent-Based%20Modeling%20with%20FRED.docx), -or the power point: [Structured FRED](https://github.com/PublicHealthDynamicsLab/FRED/raw/master/docs/Structured%20FRED.pptm). +or the power point: [Structured FRED](https://github.com/PublicHealthDynamicsLab/FRED/raw/refs/heads/FRED-v5.7.0/docs/Structured%20FRED.pptm).