docs/README.md
2024-09-17 11:40:25 -04:00

23 lines
928 B
Markdown

# Commonwealth Robotics Git Repository
This is a [Gitea](https://about.gitea.com/) instance, which will feel similar
to GitHub if you've used it. If you want an account, [email
me](mailto:jsignorovitch@commschool.org).
## Pushing to a Repository
For the security and ease of use, I suggest using `ssh` to push changes. This
guide will assume a UNIX-based operating environment (e.g. MacOS, Linux).
First, generate an ssh key pair.
```
$ ssh-keygen -f ~/.ssh/git.signorovitch.org
```
You don't need to set a password (just hit enter). This will create the files
`~/.ssh/git.signorovitch.org` and `~/.ssh/git.signorovitch.org.pub`, being your
private and public keys respectively. Using the Gitea web interface, click on
your profile in the top right corner. Go to Settings → SSH/GPG Keys → Manage
SSH Keys. Click 'Add Key' and paste your *public* key into the text box. You
should now be able to commit changes via ssh.