First commit

README.md

@@ -0,0 +1,58 @@
+MNT Reform Debian userland creation
+-----------------------------------
+
+This script built an userland "filesystem" for MNT Reform 2 laptop computer.
+**Work in Progress**: for now there is some dependencies missing for compiling
+xservser.
+
+## Usage
+
+```
+make_image.sh -r <recipe> -k <kernel> -o <output> --repository <repo> -h
+```
+
+ * `recipe`: recipe to write on the output image, default:`default`
+ * `kernel`: Linux kernel version to put on image disk, default:`5.11`
+ * `output`: output directory, default: `/output`
+ * `repo`: directory that contains all needed for building image disk
+
+## The repository
+
+The repositpry directory contains all needed to build your image disk :
+
+ * The kernel into a directory named with the version, eg `5.11` than contains
+     the kernel itself and dtb files, see [reform2_mkkernel][l_mkkern] git
+     repository
+ * The recipe directory that contains the userland filesystem, see
+     [reform2_mkuserland][l_mkusr] git repository
+ * the uboot binary, see [reform2_mkuboot][l_mkuboot] git repository
+
+## Docker
+
+You can find a Dockerfile and an entrypoint script to help you create userland
+filesystem.
+
+First you need to build the container :
+
+```
+git clone https://git.epha.se/ephase/reform_mkimage
+cd reform_mkimage
+docker build -t reform_make_image
+[...]
+```
+
+And run it :
+
+```
+docker run -v /home/docker/output:/output --rm reform_make_image
+```
+
+## Licence
+
+This work is derivated from MNT script found [here][l_mnt_image] and licenced
+under the GPLv3 Licence
+
+[l_mnt_image]:https://source.mnt.re/reform/reform-system-image/
+[l_mkusr]:https://git.epha.se/ephase/reform2_mkuserland
+[l_mkkern]:https://git.epha.se/ephase/reform2_mkkernel
+[l_mkuboot]:https://git.epha.se/ephase/reform2_mkuboot