Add README and ignore macOS .DS_Store
Some checks failed
Build Proposal and Thesis / build (push) Failing after 3m52s

This commit is contained in:
Sean O'Connor
2026-02-04 13:13:09 -05:00
parent 3b8d80ce9c
commit d88597af2b
3 changed files with 43 additions and 0 deletions

BIN
.DS_Store vendored

Binary file not shown.

41
README.md Normal file
View File

@@ -0,0 +1,41 @@
# Honors Thesis: HRIStudio
This repository contains the source code and LaTeX files for the honors thesis titled **"A Web-Based Wizard-of-Oz Platform for Collaborative and Reproducible Human-Robot Interaction Research"**.
## Project Structure
- **`thesis/`**: Contains the LaTeX source for the thesis document.
- **`chapters/`**: Modular `.tex` files for each chapter.
- **`out/`**: Directory where the final PDF (`thesis.pdf`) is generated.
- **`build/`**: Directory for intermediate build artifacts.
- **`Makefile`**: Script to automate the build process.
- **`proposal/`**: (If applicable) Contains the original thesis proposal.
## Building the Thesis
The project uses `make` to handle the LaTeX build lifecycle (pdflatex -> bibtex -> pdflatex).
### Prerequisites
- A standard LaTeX distribution (e.g., TeX Live, MacTeX).
- `make` utility.
### Commands
1. **Build the PDF:**
Navigate to the thesis directory and run `make`.
```bash
cd thesis
make
```
This will generate `thesis.pdf` in the `thesis/out/` directory.
2. **Clean Build Artifacts:**
To remove all temporary files and the generated PDF:
```bash
make clean
```
## Author
Sean O'Connor
Department of Computer Science
Bucknell University

2
thesis/.gitignore vendored
View File

@@ -1,3 +1,5 @@
.DS_Store
# LaTeX build artifacts (if they leak into root)
*.aux
*.bbl