aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2a59b9f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Archlinux-cloud
+
+A little script to build a cloud-init ready archlinux image.
+
+# Requirements
+
+For using this script you need:
+
+- A working Archlinux installation
+- The following packages installed:
+ - [libvirt](https://archlinux.org/packages/community/x86_64/libvirt/)
+ - [libisoburn](https://archlinux.org/packages/extra/x86_64/libisoburn/)
+
+# use
+
+For build an Archlinux image use the script `build.sh`. You must be root for
+using this script since we use the `mkarchiso` command.
+
+```
+./build.sh --net --qcow2 [size] --ssh [key_path]
+
+ --net enable dhcpcd
+ --qcwo2 create an image in qcow2 format instead of on ine iso format
+ [size] the size of the image you want. By default it don't resize
+ --ssh enable ssh at boot
+```