docs/README.md

# 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.

```bash
$ 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
(`~/.ssh/git.signorovitch.org.pub`) into the text box. You should now be able
to commit changes via ssh.

To confirm your configuration works, try commiting to this repository:

```bash
$ git clone git@git.signorovitch.org:commonwealth-robotics/docs.git
$ cd docs
$ echo "Something" >> user-tests/yourname.txt
$ git add user-tests/*
$ git commit -am "Your fancy commit message"
$ git push
```

If it asks for a password on the `clone` step, try:

```bash
$ ssh-agent $SHELL
$ ssh-add ~/.ssh/git.signorovitch.org
```