Commit 2f45da6c authored by David Boddie's avatar David Boddie 💬
Browse files

Added instructions for creating a standalone source dump with copyright and license information.

parent 5c43c8b7
Pipeline #59480 passed with stage
in 58 seconds
......@@ -37,6 +37,37 @@ ninja -C _build install
Installing to a standard system location will generally require `sudo` to be
used.
## Creating Standalone Information
The `tools` directory of the source repository contains two scripts that can
be used to create a standalone collection of pages for publishing.
The `librem5-mount-rootfs.py` tool is used to mount an uncompressed disk
image for the phone and update its internal `/etc/apt/sources.list` file with
source links. For example, it can be run in the following way to mount the
`/tmp/librem5.img` disk image at `/tmp/mnt` before updating its sources:
``` bash
mkdir /tmp/mnt
sudo tools/librem5-mount-rootfs.py /tmp/librem5.img /tmp/mnt
```
Once this has finished, it will prompt you to run the `dpkg-status-summary.py`
script with appropriate arguments like these:
``` bash
tools/dpkg-status-summary.py -d Evergreen /tmp/mnt /tmp/output
```
In this case, the script will create a set of pages for the Evergreen release
based on the contents of the disk image mounted at `/tmp/mnt` and write them
to the `/tmp/output` directory. It will also include copyright and license
files, as well as provide links to the sources and metadata files in the apt
repository. The `-d` option also downloads sources and metadata files for
future reference, making them available for inspection or auditing.
The output directory can then be copied to a server for publication.
## License
The source code is licensed under the GNU General Public License version 3 or
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment