From 313edfe994ab45f253aee633d5334c9ae6a8edfd Mon Sep 17 00:00:00 2001 From: Carl Colglazier Date: Fri, 23 May 2025 13:25:18 -0500 Subject: [PATCH] Create project README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..19a766e --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Mastodon Server Recommendation System + +## Guideposts + +- [manuscripts](/manuscripts/) - Contains the manuscripts for the project. +- [notebooks](/notebooks/) - Notebooks for data exploration and analysis. +- [FediRecommender](/FediRecommender/) - Python package for building and running the recommendation system. +- [codebase](/codebase/) - Place to store shared code. +- [recommender](/recommender/) - Contains the recommendation system code (front-end). +- [presentations](/presentations/) - Slide decks. +- [scripts](/scripts/) - Scripts for data processing and analysis. + +## Getting Started + +### Environment Setup + +This project uses [renv](https://rstudio.github.io/renv/) to manage R package dependencies. To set up the environment, run the following command in R: + +```r +renv::restore() +``` + +This will install all the required packages and their dependencies. + +