diff --git a/README.md b/README.md new file mode 100644 index 0000000..dd53282 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +swh-mirror-forge +================ + +Mirror swh's forge to github + +# Configuration + +In $SWH_CONFIG_PATH/mirror-forge/config.yml (SWH_CONFIG_PATH being one +of /etc/softwareheritage/,~/.config/swh, or ~/.swh/), add the +following information: + +```yaml +github: +forge: +``` + +Docs: +- github: https://github.com/settings/tokens +- swh forge: https://forge.softwareheritage.org/settings/user//page/apitokens/ + +# Use + +For now, on a per repository basis: + +```sh +python3 -m swh.mirror.forge.sync --repo-callsign DMOD \ + --repo-name swh-model \ + --repo-url https://forge.softwareheritage.org/source/swh-model/ \ + --repo-description "" \ + --credential-key-id 3 +```