From 5d96d517c15e7e0e1ba37923aa35bb40d64b72e9 Mon Sep 17 00:00:00 2001
From: TYLER CARAZA-HARTER <tharter@cs544-tharter.cs.wisc.edu>
Date: Wed, 29 Jan 2025 14:04:38 -0600
Subject: [PATCH] re-arrange repo init directions

---
 projects.md | 38 ++++++++++++++++++++++++++------------
 1 file changed, 26 insertions(+), 12 deletions(-)

diff --git a/projects.md b/projects.md
index 0e03c97..fab78ab 100644
--- a/projects.md
+++ b/projects.md
@@ -62,6 +62,24 @@ ways to authenticate.  One is via SSH key:
 8. copy the "Clone with HTTPS" URL
 9. on your VM, run `git clone URL` (replacing "URL" with the one you copied)
 
+### Initialization
+
+Your initial repository should have a `requirements.txt` file listing
+some packages we'll use for projects.  You can create a Python virtual
+environment (for using these packages for a specific project, instead
+of across the whole system), then install them as follows:
+
+```
+sudo apt install python3-venv
+python3 -m venv venv
+source venv/bin/activate
+pip3 install -r requirements.txt
+```
+
+### Read-Only Files
+
+> **NOTE**: Do NOT touch or edit `submit.sh`, `.gitlab-ci.yml` in your repository. These files are used to automate grading. Editing them could hinder your ability to submit properly.
+
 <!--
 To clone your GitLab repository on a VM, you can run the following command:
 ```bash
@@ -110,7 +128,6 @@ You can double check that the `env` variable was saved with:
 ```bash
 echo $GITLAB_ACCESS_TOKEN
 ```
--->
 
 ### Environment
 If one does not already exist for your project, create a `venv`:
@@ -127,17 +144,18 @@ sudo apt install python3-venv
 
 and use `python3` instead of `python3.10` when creating your `venv`.
 
-### Autograder
-We have developed a CLI to run the autograder for your projects. We highly encourage you run this on your code locally to check your progress.
+-->
+
+## Testing
+
+We have developed a command-line tool to run the autograder for your projects. We highly encourage you run this on your code locally to check your progress.
 
 > **NOTE**: Running `autobadger` on your machine does NOT submit your assignment (more on that below).
 
-To use it, be sure to be in your `venv` in the terminal. Simply install using:
+To use it, make your your `venv` is still active in the terminal.
+
+You can run `autobadger` as a command in the terminal:
 
-```bash
-pip install -r requirements.txt
-```
-If the installation was successful, you will be able to run `autobadger` as a command in the terminal:
 ```bash
 autobadger --info
 ```
@@ -155,10 +173,6 @@ To update the version, you can the following (again, inside your `venv`):
 pip install -r requirements.txt --force-reinstall
 ```
 
-### Read-Only Files
-
-Do NOT touch or edit `submit.sh`, `.gitlab-ci.yml` in your repository. These files are used to automate grading. Editing them could hinder your ability to submit properly.
-
 ## Submission
 
 Whenever you push to `main`, we determine that as a "submission" and run `autobadger` on your `main` branch. We then push our results to your repository under `Issues`. This issue will contain the contents of `autobadger` as well as some other metadata and notes. This *should* have the same output as if you were to run it locally. If anything seems terribly wrong, please email your [assigned TA](https://docs.google.com/spreadsheets/d/1HwI0o3IE97AWe_P_sKRPrUITPPGEdvsLzfEKcrP8NrU/edit?usp=sharing) with a link to your GitLab issue.
-- 
GitLab