aboutsummarylogtreecommitdiffstats
diff options
context:
space:
mode:
authoryardenac2013-04-27 23:10:55 -0700
committeryar2015-07-03 16:58:25 -0700
commit32681d0e33a6d10fe6d0768cfc9a6f704f92b4ae (patch)
tree0a2de5e1fa8f3a6e6a95dd11d0d20dbd4bcd697d
parent0ec6a50095f9af57ffdf0fad819203559b0cbc45 (diff)
downloadaur-32681d0e33a6d10fe6d0768cfc9a6f704f92b4ae.tar.gz
new README
-rw-r--r--README21
-rw-r--r--README.md24
2 files changed, 24 insertions, 21 deletions
diff --git a/README b/README
deleted file mode 100644
index 7ea109b8ad0a..000000000000
--- a/README
+++ /dev/null
@@ -1,21 +0,0 @@
-Linode (http://www.linode.com) is a VPS host which supports Arch Linux servers
-and custom kernels. This project gives you an Arch kernel for your Linode.
-
-linux-linode is designed to closely track Arch kernel development while being as
-resource friendly as possible. Compiles specifically for Linode's CPUs and
-removes unneeded hardware support (i.e. almost everything besides xen block dev,
-NICs & console). Also defaults to removing all filesystems but ext3 and
-compiling in many things that are usually modules (fuse, dm-crypt for example)
-but you can of course nconfig whatever you want. :)
-
-Includes a grub boot menu where Linode expects to find it. You do NOT need grub,
-grub2, grub-legacy or any other. grub-legacy is a conflict because of menu.lst.
-
-This is a 64-bit kernel, so make sure you're using their 64-bit Arch image!
-
-Steps to use:
-
- 1) pacman -Syu
- 2) pacman -U /path/to/linux-linode-*-x86_64.pkg.tar.xz
- 3) reboot your Linode with "kernel" set to: pv-grub-x86_64
- 4) report bugs ;)
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..e2f5eee08b84
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# THE BACKGROUND:
+
+Linode (http://www.linode.com) is a VPS host which supports Arch Linux servers and custom kernels. This project gives you an Arch kernel for your Linode.
+
+# THE PROBLEM:
+
+Linode does not distribute their kernel configs - you have to boot into one and read /proc/config.gz. Arch's vanilla x86_64 will boot, but is full of drivers you will never ever use on a Linode. Arch's i686 will not work at all.
+
+# THE SOLUTION:
+
+This package provides a working, semi-minimalist kernel. It boots and is fine to run as-is for most things. (I do!) It can also be your starting point for tweaking.
+
+Configs are a compromise between vanilla Linode and Arch. Most drivers are disabled, while a lot of ciphers and net stuff are inline. Few actual modules are left. This is not to everyone's taste, so hack away.
+
+# GRUB MENU INCLUDED
+
+Includes a grub boot menu where Linode expects to find it. You do NOT need grub, grub2, grub-legacy or any other. grub-legacy is a conflict because of menu.lst.
+
+Steps to use:
+
+ 1) pacman -Syu
+ 2) pacman -U $pkgfile
+ 3) reboot your Linode with a pv-grub kernel
+ 4) report bugs ;)