Skip to content

Commit 6f9b0af

Browse files
author
Max Paulus
authored
Update README.md
1 parent fec55c4 commit 6f9b0af

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
## For learners
44

5-
This repository keeps track of the code being written by the instructor.
6-
Use it to catch up or as a reference when running into errors.
5+
This repository keeps track of the code being written by the instructor
6+
- refresh the page regularly to see the current changes
7+
- use it to catch up or as a reference when running into errors
8+
- the folder structure is a good starting point when creating a project yourself
79

8-
The folder structure is a good starting point when creating a project yourself.
10+
---
911

1012
## For instructors
1113

@@ -29,8 +31,9 @@ Use [gitautopush](https://pypi.org/project/gitautopush/) to automatically push y
2931

3032
### Troubleshooting
3133

34+
- github requires SSH authentication
35+
- Follow [these instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
36+
- if you are being asked to enter your passphrase every time git tries to push changes, launch the ssh agent automatically, follow [these instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases); note that in certain cases your profile or bashrc file is not read when starting up the shell, in this case add `test -f ~/.profile && . ~/.profile` or `test -f ~/.bashrc && . ~/.bashrc` respectively to your .bash_profile.
3237
- ValueError: A `git status` command didn't work, are you sure this is a git repository?
3338
- It might be occuring when there are already some changes to be staged once you launch `gitautopush`. First, run `gitautopush`, then start creating files or making changes to the existing ones.
3439
- Another thing to try is to first commit and push one file manually to the repository, once you have done that and no changes are staged run `gitautopush`
35-
36-

0 commit comments

Comments
 (0)