Skip to content

Commit

Permalink
Updated the README to reflect the new template repo status.
Browse files Browse the repository at this point in the history
  • Loading branch information
eriq-augustine committed Aug 6, 2024
1 parent 39bf380 commit 0b6b2ef
Showing 1 changed file with 4 additions and 48 deletions.
52 changes: 4 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Some improvements from the original project:
### FAQ

**Q:** What version of Python does this project support?
**A:** Python >= 3.5.
**A:** Python >= 3.8.
The original version of this project was written for Python 2, but it has since been updated.

**Q:** What dependencies do I need for this project?
Expand All @@ -40,53 +40,9 @@ The rest will be supplied by the autograder.
This makes it clear to the student what files they are allowed to change.

**Q:** How do I get my own copy of repo to develop on?
**A:** They typical answer would be to [fork it](https://help.github.com/en/articles/fork-a-repo).
However GitHub requires that all forks be public, and we don't want this for class assignments.
The following section has instructions on making a private copy of this repo.

### Making a Private Pacman Repo

First, make a [new Github repository](https://github.com/new).
You can name it whatever you want (you can even keep the name `pacman`).
For this example, we will call our repository `cool-pacman`.
Make sure to make the repository private and **do not** initialize the repository with a README.
Private repositories are currently free on GitHub.
After clicking "Create Repository", the next page should have the link to this new repository.
For this example, we will use `https://github.com/eriq-augustine/cool-pacman.git`.

Now, clone **this** pacman repo (the one that you are reading this README on):
```
git clone https://github.com/linqs/pacman.git
cd pacman
```
If you are a cool kid with [ssh keys](https://help.github.com/en/articles/connecting-to-github-with-ssh), then you can use the ssh endpoint instead of the http endpoint listed above.

If you accidentally already created a pacman fork, then you can just cd into the fork repository you already cloned.
(Just make sure to delete the fork through the GitHub web interface after you finish these steps.)

Next, we will change the cloned repository's remote url to point to our new repository.
You can do this via the `git remote set-url` command:
```
git remote set-url origin https://github.com/eriq-augustine/cool-pacman.git
```
Or, you can just directly edit the `.git/config` file (the url under `[remote "origin"]`).

Finally, you just need to push to your new repository:
```
git push
```

You're all set!
You now have a private copy of this pacman repo.

#### Pulling Changes from This Repo Into Your Fork

Occasionally, you may need to pull changes/fixes from this repository.
Doing so is super easy.
Just do a `git pull` command and specify this repository as an argument:
```
git pull https://github.com/linqs/pacman.git
```
**A:** Anyone who will be committing solutions should use this template repository to create a **private repository**.
Directions for that can be found [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
For anyone else, you can just [fork it](https://help.github.com/en/articles/fork-a-repo) as you normally would.

### Acknowledgements

Expand Down

0 comments on commit 0b6b2ef

Please sign in to comment.