aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index 226639086..28b3a743e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,21 @@
+[//]: # (Copyright 2019 Gentoo Authors)
+
Gentoo Big Forum Upgrade
========================
-Initial content just to prove I have commit access.
+## Working with the Forums Repository
+
+The forums repository is set up with multiple independent branches with no
+common ancestor. It is also set up to track two different remote git
+repositories:
+
+ * The phpBB repository, which will be called "upstream" by convention.
+ * The Gentoo Forums repository, which will be called "origin" by convention
+ and tradition.
+
+Checking out the repository:
+```
+git clone git+ssh://git@git.gentoo.org/proj/forums.git
+git remote add upstream git@github.com:phpbb/phpbb.git
+```
-One more line.