diff --git a/doc/developer.rst b/doc/developer.rst index 7477c6e..f239c30 100644 --- a/doc/developer.rst +++ b/doc/developer.rst @@ -11,7 +11,7 @@ available in the ``buildEnv`` derivation. .. code-block:: console - nix-shell -A buildEnv --arg device '(import ./devices/qemu)' + nix-shell -A buildEnv Emulated devices @@ -27,7 +27,7 @@ To build it, .. code-block:: console - NIX_PATH=nixpkgs=../nixpkgs:$NIX_PATH nix-build -I liminix-config=path/to/your/configuration.nix --arg device "import ./devices/qemu" -A outputs.default + nix-build -I liminix-config=path/to/your/configuration.nix --arg device "import ./devices/qemu" -A outputs.default In a ``buildEnv`` nix-shell, you can use the ``mips-vm`` command to run Qemu with appropriate options. It connects the Liminix @@ -35,7 +35,7 @@ serial console and the `QEMU monitor `_ for convenience and visibility: you can open PRs against that diff --git a/doc/user.rst b/doc/user.rst index 1b5b359..3c447b2 100644 --- a/doc/user.rst +++ b/doc/user.rst @@ -23,19 +23,17 @@ it. For example: .. code-block:: console - NIX_PATH=nixpkgs=../nixpkgs:$NIX_PATH nix-build -I liminix-config=./tests/smoke/configuration.nix --arg device "import ./devices/qemu" -A outputs.default + nix-build -I liminix-config=./tests/smoke/configuration.nix --arg device "import ./devices/qemu" -A outputs.default ``outputs.default`` is intended to do something appropriate for the device, whatever that is. For the qemu device, it creates a directory containing a squashfs root image and a kernel. -As of Feb 2023, flashing devices is not implemented other than by -taking the covers off and connecting wires to the serial console -pads - so, check in the Developer Manual. - Future versions of this manual will at this point refer to device-specific instructions for installing Liminix using the router's -Web UI or other non-invasive method. +Web UI or other non-invasive method. As of Feb 2023, the only way to +flash a device is to take the cover off and connect wires to the +serial console pads - so, check in the Developer Manual. Updating a running device diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..d5db325 --- /dev/null +++ b/shell.nix @@ -0,0 +1,8 @@ +let + nixpkgs = ; + liminix = (import ./default.nix { + device = (import ./devices/qemu); + liminix-config = ./vanilla-configuration.nix; + inherit nixpkgs; + }); +in liminix