summaryrefslogtreecommitdiffstats
path: root/site/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'site/readme.txt')
-rw-r--r--site/readme.txt44
1 files changed, 44 insertions, 0 deletions
diff --git a/site/readme.txt b/site/readme.txt
new file mode 100644
index 0000000..6f388ce
--- /dev/null
+++ b/site/readme.txt
@@ -0,0 +1,44 @@
+This is a clone of the libreboot website at libreboot.org. The main
+intention is to allow people to contribute to the website, but it
+can also help people to mirror the site if they want to.
+
+Mirroring libreboot:
+
+(these instructions aren't complete, and you can also cherry pick what
+you need instead of following these exactly)
+
+change the info in variables.php to what you want
+
+clone libreboot(website) and make that directory your docroot.
+
+Now, outside of the libreboot(website) clone, clone libreboot(firmware)
+and build it fully, using the libreboot instructions.
+in libreboot(website) clone, create a symlink called "git" to the
+release/ directory in your libreboot(firmware) clone.
+
+Setup a repository for your version of libreboot(website) in
+libreboot.org.git/ (or actually, whatever you want) in your
+libreboot(website) clone.
+
+Setup a repository for your version of libreboot(firmware) in
+libreboot.git (or actually, whatever you want) in your libreboot (website)
+clone.
+
+That's right. A repository in a clone of that repository.
+
+Populate docs/ in your libreboot(website) clone with a copy of docs/
+from your release archives. Advice: always keep these strictly for stable
+releases only (you can also backport stuff, as well).
+
+gitdocs/ should be a symlink to the docs/ directory in your clone of
+libreboot(firmware).
+
+Create a symlink "gitdocs" in your libreboot(website) clone pointing
+to docs/ in your libreboot(firmware) clone.
+
+Populate release/ with releases from the libreboot project.
+
+
+The live site should not expose the .git files/directories, only
+the repository should be accessible. Also, in the config file make sure
+to replace any paths from your system with the URL of your remote.