diff --git a/README.md b/README.md new file mode 100644 index 0000000..1203df4 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# NetModule OEM Linux +The purpose of this repository is to provide a base or a template for customers to build their own distribution based on the NetModule OEM Linux distribution. + +The submodules and source revisions are frozen to match the latest release. + + +## Selecting hardware target +The hardware target can be selected by sourcing the machine_select script: +``` +source machine_select +8 # Selecting NG800 +``` + +## Building an image +This distribution provides three images: + +1. The minimal image +2. The "release" image +3. The development image + +### The minimal image +It is a initramfs image which can be loaded from the bootloader. It gives access to basic linux functionalities and allows to flash other images. + +It can be built with the following commands: +``` +source env.image-minimal +bitbake virtual/netmodule-image +``` + +### The "release" image +This is the default image providing all functionalities of the system. + +It can be build with the following commands: +``` +source env.image-ostree +bitbake netmodule-linux-image +``` + +### The development image +This is the default image extended with development and debugging tools. + +It can be build with the following commands: +``` +source env.image-ostree +bitbake netmodule-linux-image-dev +```