Skip to content

Added link to documentation to README #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
spgarbet wants to merge 5 commits into
base: FRED-v5.7.0
Choose a base branch
from
Open

Added link to documentation to README #55

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
084d5a4
Updated README to include link to documentation
spgarbet Feb 19, 2025
6fb37db
Trying to make link downloadable and relative for README documentation
spgarbet Feb 19, 2025
910b2e4
Another guess at format
spgarbet Feb 19, 2025
1507080
Cannot get relative raw link to work, going for direct to source link
spgarbet Feb 19, 2025
fa93898
Links are unfortunately into a specific tag release
spgarbet Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,9 @@ export PATH="$FRED_HOME/bin:${PATH}"
export PATH="$FRED_HOME/pybin/bin:${PATH}"
export FRED_GNUPLOT=<PATH TO 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](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/refs/heads/FRED-v5.7.0/docs/Structured%20FRED.pptm).