Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 15 additions & 15 deletions docs/setup_caen.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ $ make clean

Next, copy files using `rsync`. Remember to change `awdeorio` to your username.
```console
$ rsync -rtv --exclude '.git*' ../stats/ awdeorio@login-course.engin.umich.edu:stats-copy/
$ rsync -rtv --exclude '.git*' ../p1-stats/ awdeorio@login-course.engin.umich.edu:p1-stats-copy/
building file list ... done
created directory stats-copy
created directory p1-stats-copy
./
Makefile
main.cpp
Expand Down Expand Up @@ -133,12 +133,12 @@ caen-vnc-vm16.engin.umich.edu
Notice that the folder copied earlier.
```console
$ ls
stats-copy
p1-stats-copy
```

Change directory into the copied folder and double-check that all binary files are cleaned up.
```console
$ cd stats-copy
$ cd p1-stats-copy
$ make clean
```

Expand Down Expand Up @@ -202,7 +202,7 @@ $

Open a second terminal and run an `rsync` command, which uses the new configuration. No authentication is required!
```console
$ rsync -rtv --exclude '.git*' ../stats/ awdeorio@login-course.engin.umich.edu:stats-copy/
$ rsync -rtv --exclude '.git*' ../p1-stats/ awdeorio@login-course.engin.umich.edu:p1-stats-copy/
building file list ... done

sent 273 bytes received 20 bytes 586.00 bytes/sec
Expand All @@ -229,37 +229,37 @@ SSH to a CAEN Linux machine and see the copy we made earlier using `rsync`.
```console
$ ssh awdeorio@login-course.engin.umich.edu
$ ls
stats-copy # this is from our rsync'ed copy earlier
p1-stats-copy # this is from our rsync'ed copy earlier
```

Notice that the copy is *not* under version control.
```console
$ cd stats-copy
$ cd p1-stats-copy
$ git status
fatal: Not a git repository (or any of the parent directories): .git
```

Change directory and `git clone` your repo.
```console
$ cd ~ # This will move to your home directory
$ git clone https://github.com/awdeorio/stats.git
$ git clone https://github.com/awdeorio/p1-stats.git
$ ls
stats stats-copy
p1-stats p1-stats-copy
```

## Pro-tips

### Synchronizing deleted files
Tell `rsync` to synchronize deleted files. In other words, if it's gone on your laptop, delete it on CAEN.
```console
$ rsync -rtv --delete --exclude '.git*' ../stats/ awdeorio@login-course.engin.umich.edu:stats-copy/
$ rsync -rtv --delete --exclude '.git*' ../p1-stats/ awdeorio@login-course.engin.umich.edu:p1-stats-copy/
```
{: data-variant="no-line-numbers" }

### Don't synchronize Git-ignored files
Tell `rsync` not to synchronize files ignored by Git. You can also combine this option with `--delete`.
```console
$ rsync -rtv --exclude '.git*' --filter=':- .gitignore' ../stats/ awdeorio@login-course.engin.umich.edu:stats-copy/
$ rsync -rtv --exclude '.git*' --filter=':- .gitignore' ../p1-stats/ awdeorio@login-course.engin.umich.edu:p1-stats-copy/
```
{: data-variant="no-line-numbers" }

Expand All @@ -273,8 +273,8 @@ sync :
--delete \
--exclude '.git*' \
--filter=':- .gitignore' \
../stats/ \
awdeorio@login-course.engin.umich.edu:stats-copy/
../p1-stats/ \
awdeorio@login-course.engin.umich.edu:p1-stats-copy/
```

Now you can type `make sync` as a short cut.
Expand All @@ -285,8 +285,8 @@ rsync \
--delete \
--exclude '.git*' \
--filter=':- .gitignore' \
../stats/ \
awdeorio@login-course.engin.umich.edu:stats-copy/
../p1-stats/ \
awdeorio@login-course.engin.umich.edu:p1-stats-copy/
building file list ... done
./
Makefile
Expand Down
10 changes: 5 additions & 5 deletions docs/setup_eecs281.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ This tutorial walks through EECS 281 project setup using EECS 280 tutorials.
VS Code works great for EECS 281 projects. Just ask one of the IAs or GSIs who use VS Code if you need help.

## Visual debugger
Set up your project in your visual debugger. We'll use the project name `stats` in this example, but your project name may be different. If your project has starter files, you'll need the link from the project spec.
Set up your project in your visual debugger. We'll use the project name `p1-stats` in this example, but your project name may be different. If your project has starter files, you'll need the link from the project spec.

| [VS Code Tutorial](https://eecs280staff.github.io/tutorials/setup_vscode.html)| [Visual Studio Tutorial](https://eecs280staff.github.io/tutorials/setup_visualstudio.html) | [Xcode Tutorial](https://eecs280staff.github.io/tutorials/setup_xcode.html) |

After you're done, you should have a folder with a main file. Your files may be different.
```console
$ tree stats/
stats/
$ tree p1-stats/
p1-stats/
├── main.cpp
...
```
Expand Down Expand Up @@ -185,8 +185,8 @@ Your branch is up-to-date with 'origin/main'.

nothing to commit, working tree clean
$ git remote -v
origin https://github.com/awdeorio/stats.git (fetch)
origin https://github.com/awdeorio/stats.git (push)
origin https://github.com/awdeorio/p1-stats.git (fetch)
origin https://github.com/awdeorio/p1-stats.git (push)
```

You should have a `.gitignore` file ([instructions](https://eecs280staff.github.io/tutorials/setup_git.html#create-a-local-repository)).
Expand Down
6 changes: 3 additions & 3 deletions docs/setup_emacs.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,8 @@ Emacs doesn't require any special setup for a project.
Create a new directory, then move into the new directory. Your folder location might be different.

```console
$ mkdir ~/eecs280/stats
$ cd ~/eecs280/stats
$ mkdir ~/eecs280/p1-stats
$ cd ~/eecs280/p1-stats
```

### Add new files
Expand Down Expand Up @@ -504,7 +504,7 @@ Alice connects to a remote server containing her code. She starts a tmux sessio
$ ssh login-course.engin.umich.edu
$ hostname
caen-vnc-vm05.engin.umich.edu
$ cd stats
$ cd p1-stats
$ tmux new -s shared
$ emacs -nw main.cpp
```
Expand Down
48 changes: 24 additions & 24 deletions docs/setup_git.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ If you've used version control before on your computer, skip to the [Create a lo
</div>

## Prerequisites
We're assuming that you already have a folder, e.g., `seam-carving/` or `stats/`. Your folder name may be different. It's OK if there aren't any files in it yet.
We're assuming that you already have a folder, e.g., `p2-image-processing/` or `p1-stats/`. Your folder name may be different. It's OK if there aren't any files in it yet.
```console
$ pwd
/Users/awdeorio/Developer/eecs280/seam-carving
/Users/awdeorio/Developer/eecs280/p2-image-processing
```

You have installed `git`. Your version might be different.
Expand Down Expand Up @@ -147,7 +147,7 @@ Only one team member creates the first local repository.
Navigate to your project directory. Your directory might be different.
```console
$ pwd
/Users/awdeorio/Developer/eecs280/seam-carving
/Users/awdeorio/Developer/eecs280/p2-image-processing
```

### Add a `.gitignore` file
Expand All @@ -157,7 +157,7 @@ Add a `.gitignore` file. This will prevent Git from controlling files like comp
This sample is pre-configured to work with most C++ projects, so use the same sample file for all EECS 280/281 projects.
```console
$ pwd
/Users/awdeorio/src/eecs280/seam-carving
/Users/awdeorio/src/eecs280/p2-image-processing
$ wget https://eecs280staff.github.io/tutorials/dot_gitignore_sample -O .gitignore
$ ls -A
.gitignore ...
Expand All @@ -167,7 +167,7 @@ $ ls -A
Initialize the repo. You may have more untracked files.
```console
$ git init
Initialized empty Git repository in /Users/awdeorio/Developer/eecs280/seam-carving/.git/
Initialized empty Git repository in /Users/awdeorio/Developer/eecs280/p2-image-processing/.git/
$ git status
On branch main

Expand Down Expand Up @@ -268,7 +268,7 @@ Create a new project.

<img src="images/github003.png" width="384px" />

Call the new project `seam-carving`, mark it as "private". Click "Create repository".
Call the new project `p2-image-processing`, mark it as "private". Click "Create repository".

<div class="primer-spec-callout danger" markdown="1">
**Double check that you have selected "private".** Making your project code or test cases publicly available online is a violation of the honor code.
Expand All @@ -280,7 +280,7 @@ Triple-check that your new repository is private. If you made a mistake, you ca

<img src="images/github005a.png" width="768px" />

You now have a project page for your remote repo. In this example, awdeorio's project page is [https://github.com/awdeorio/seam-carving](https://github.com/awdeorio/seam-carving). You won't have access to it because it's private, but your page should look similar.
You now have a project page for your remote repo. In this example, awdeorio's project page is [https://github.com/awdeorio/p2-image-processing](https://github.com/awdeorio/p2-image-processing). You won't have access to it because it's private, but your page should look similar.

<img src="images/github005b.png" width="768px" />

Expand All @@ -295,8 +295,8 @@ Browse to your repository's project page from [https://github.com/](https://gith
Connect your local repo to your remote repo.
```console
$ pwd
/Users/awdeorio/Developer/eecs280/seam-carving
$ git remote add origin https://github.com/awdeorio/seam-carving.git # use your URL
/Users/awdeorio/Developer/eecs280/p2-image-processing
$ git remote add origin https://github.com/awdeorio/p2-image-processing.git # use your URL
```

<div class="primer-spec-callout warning" markdown="1">
Expand All @@ -305,15 +305,15 @@ $ git remote add origin https://github.com/awdeorio/seam-carving.git # use your
If you're using [SSH Keys](#ssh-keys), you'll see `git@github.com`.
```console
$ git remote -v
origin git@github.com:awdeorio/seam-carving.git (fetch)
origin git@github.com:awdeorio/seam-carving.git (push)
origin git@github.com:awdeorio/p2-image-processing.git (fetch)
origin git@github.com:awdeorio/p2-image-processing.git (push)
```

If you're using GitHub [Personal Access Tokens](#personal-access-token), you'll see `https://`.
```console
$ git remote -v
origin https://github.com/awdeorio/seam-carving.git (fetch)
origin https://github.com/awdeorio/seam-carving.git (push)
origin https://github.com/awdeorio/p2-image-processing.git (fetch)
origin https://github.com/awdeorio/p2-image-processing.git (push)
```
</div>

Expand All @@ -327,7 +327,7 @@ Delta compression using up to 4 threads.
Compressing objects: 100% (12/12), done.
Writing objects: 100% (14/14), 6.97 KiB | 3.48 MiB/s, done.
Total 14 (delta 0), reused 0 (delta 0)
To https://github.com/awdeorio/seam-carving.git
To https://github.com/awdeorio/p2-image-processing.git
* [new branch] main -> main
Branch 'main' set up to track remote branch 'main' from 'origin'.
```
Expand All @@ -342,7 +342,7 @@ Branch 'main' set up to track remote branch 'main' from 'origin'.
```console
$ git push -u origin main
error: src refspec main does not match any
error: failed to push some refs to 'github.com:awdeorio/seam-carving.git'
error: failed to push some refs to 'github.com:awdeorio/p2-image-processing.git'
```

You can rename your local branch to `main` to resolve this.
Expand Down Expand Up @@ -497,7 +497,7 @@ Delta compression using up to 4 threads.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 361 bytes | 361.00 KiB/s, done.
Total 3 (delta 1), reused 0 (delta 0)
To https://github.com/awdeorio/seam-carving.git
To https://github.com/awdeorio/p2-image-processing.git
350f38e..7fa8093 main -> main
$ git status
On branch main
Expand Down Expand Up @@ -600,7 +600,7 @@ Delta compression using up to 4 threads.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 348 bytes | 348.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0)
To https://github.com/awdeorio/seam-carving.git
To https://github.com/awdeorio/p2-image-processing.git
a80db0b..2fac8d1 main -> main
```

Expand Down Expand Up @@ -655,8 +655,8 @@ $ whoami
awdeorio
$ pwd
/Users/awdeorio/src/eecs280/
$ git clone https://github.com/awdeorio/seam-carving.git
Cloning into 'seam-carving...
$ git clone https://github.com/awdeorio/p2-image-processing.git
Cloning into 'p2-image-processing...
```

Remember, other team members don't need to download the starter files again because those files were already added by the first team member.
Expand Down Expand Up @@ -687,9 +687,9 @@ To fix the conflict, follow [this how-to]( https://help.github.com/articles/reso
If you get a `rejected` error when using `git push`, this probably means you (or your partner) changed your repo using another computer (or the GitHub web interface).
```console
$ git push
To https://github.com/awdeorio/seam-carving.git
To https://github.com/awdeorio/p2-image-processing.git
! [rejected] main -> main (fetch first)
error: failed to push some refs to 'https://github.com/awdeorio/seam-carving.git'
error: failed to push some refs to 'https://github.com/awdeorio/p2-image-processing.git'
```

Fetch changes from the remote repo.
Expand All @@ -699,7 +699,7 @@ remote: Counting objects: 3, done.
remote: Compressing objects: 100% (3/3), done.
remote: Total 3 (delta 2), reused 0 (delta 0)
Unpacking objects: 100% (3/3), done.
From https://github.com/awdeorio/seam-carving
From https://github.com/awdeorio/p2-image-processing
4d375b4..2b9bea7 main -> origin/main
```

Expand Down Expand Up @@ -735,7 +735,7 @@ Delta compression using up to 4 threads.
Compressing objects: 100% (3/3), done.
Writing objects: 100% (3/3), 318 bytes | 318.00 KiB/s, done.
Total 3 (delta 2), reused 0 (delta 0)
To https://github.com/awdeorio/seam-carving.git
To https://github.com/awdeorio/p2-image-processing.git
2b9bea7..63a5d0b main -> main
$ git status
On branch main
Expand All @@ -758,7 +758,7 @@ First, remove your GitHub repository. Browse to your repository's project page
Next, remove the hidden files created by `git`. Remember, hidden files start with a dot (`.`).
```console
$ pwd
/Users/awdeorio/Developer/eecs280/seam-carving
/Users/awdeorio/Developer/eecs280/p2-image-processing
$ rm -rf .git/ .gitignore
$ ls -A
```
Expand Down
6 changes: 3 additions & 3 deletions docs/setup_lldb.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Run with LLDB. You now see the LLDB prompt. LLDB's interface is similar to you
```
$ lldb main.exe
(lldb) target create "./main.exe"
Current executable set to '/Users/awdeorio/src/eecs280/stats/main.exe' (arm64).
Current executable set to '/Users/awdeorio/src/eecs280/p1-stats/main.exe' (arm64).
```

The `r` command runs the program.
Expand Down Expand Up @@ -176,7 +176,7 @@ Start LLDB.
```console
$ lldb main.exe
(lldb) target create "main.exe"
Current executable set to '/Users/awdeorio/src/eecs280/stats/main.exe' (arm64).
Current executable set to '/Users/awdeorio/src/eecs280/p1-stats/main.exe' (arm64).
```

### Breakpoint
Expand All @@ -202,7 +202,7 @@ Run the program being debugged. The program pauses at the breakpoint.

```
(lldb) r
Process 72957 launched: '/Users/awdeorio/src/eecs280/stats/main.exe' (arm64)
Process 72957 launched: '/Users/awdeorio/src/eecs280/p1-stats/main.exe' (arm64)
Process 72957 stopped
* thread #1, queue = 'com.apple.main-thread', stop reason = breakpoint 1.1
frame #0: 0x0000000100003e48 main.exe`main at main.cpp:14:18
Expand Down
2 changes: 1 addition & 1 deletion docs/setup_macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ We highly recommend you store all coding work for EECS 280 projects and labs her
| Bad Example | Good Example |
|-----------------|----------------|
| `EECS 280/` | `eecs280/` |
| `EECS 280 Stats Project/` | `stats/` |
| `Project 1 Stats/` | `p1-stats/` |

</div>

Expand Down
Loading
Loading