Add a readme file

1 files changed, 36 insertions, 0 deletions

diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..3a64b1b
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,36 @@
+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).
+
+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.