From 2762c40b845e173a69bd054283440ea29313d571 Mon Sep 17 00:00:00 2001 From: Phantop Date: Tue, 25 Oct 2022 14:01:53 -0400 Subject: [PATCH] Update READMEs --- README.md | 24 +++++++++++------------- apps/README.md | 22 +++++++++++++--------- 2 files changed, 24 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 3853db0..cf29ce5 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,10 @@ cannot guarantee it will function without issue. In order to create the images, you will need: -- Some coreutils implementation - [dwarfs](https://github.com/mhx/dwarfs), specifically `mkdwarfs` - This may in turn require further dependencies, and specifically relies on the presence of FUSE for mounting images. - - `dwarfsck` and `dwarfsextract` also allow for additional functionality -- Squashfs-tools for AppImage functionality + - `dwarfsck` and `dwarfsextract` also allow for converting existing dwarfs images and updating the header of existing appdwarfs +- squashfs-tools for AppImage conversion - `zstd` for creating or running `zzexe` files If you only wish to run an existing appdwarf, only `dwarfs` is needed in PATH. @@ -30,24 +29,23 @@ that meet the GitHub criteria on AppImageHub. Any files that are found but are n AppImages will be compressed using `zzexe`. The apps folder contains other scripts for specific programs that will download all -necessary files and create a resulting appdwarf in the same folder. +necessary files and create a resulting appdwarf in the `bin` subfolder. ## `zzexe` `zzexe` is a small tool similar to `gzexe` that instead uses zstd to compress single applications. I've included it because it has a similar goal to `appdwarf` on the whole, just on a smaller scale. -I wrote it in part because I felt that `gzexe` was overly complicated, as I used to -just use a lightly modified version of it that replaces `gzip` with `zstd`, -and to add a couple additional features. +I wrote it in part because I felt that `gzexe` was overly complicated, as I had been +using lightly modified version of it that replaces `gzip` with `zstd`, and to add a +couple additional features: -It supports adding in a prefix command to the file using the `-p` options e.g. -`zzexe -p wine some.exe` will generate a compressed file that will then run the exe. - -It also automatically appends the extension of the source file to the temporary file +- supports adding in a prefix command to the file using the `-p` option + - e.g. `zzexe -p wine some.exe` will generate a compressed file that will then run the exe with wine +- automatically appends the extension of the source file to the temporary file created when ran since some programs care about that, such as an emulator only running games of an expected file extension. -As of June 2022, `zzexe` has been integrated into the main `appdwarf` script. +*As of June 2022, `zzexe` has been integrated into the main `appdwarf` script. I have implemented a heuristic that should automatically detect regular files and -run `zzexe` on them, however you can directly invoke it with the `-z` option. +run `zzexe` on them, however you can directly invoke it with the `-z` option.* diff --git a/apps/README.md b/apps/README.md index af5bfbc..7708ab0 100644 --- a/apps/README.md +++ b/apps/README.md @@ -4,20 +4,24 @@ This directory contains various scripts I've put together to quickly and easily images of various large and/or popular programs. I give no guarantee that they will work correctly or as desired; these have been put together largely for my own usage. -These scripts are all targeted for using on x86_64 Linux systems with GLIBC. +These scripts are all targeted for use on x86_64 Linux systems with GLIBC. ## Scripts Script | Function | Source --- | --- | --- -`mkgo ` | Latest official Go release | -`mkjava ` | Accepts an argument for Java version and obtains that build from Adoptium | -`mkmp3tag ` | Latest 64-bit Mp3tag release | -`mknode ` | Latest official NodeJS release | -`mkpypy ` | Latest PyPy3 release | -`mkrust ` | Latest Rust nightly | +`mkdotnet` | Latest LTS .NET runtime +`mkeopkg` | Converts the given Solus package(s) to an appdwarf | +`mkgo` | Latest official Go release | +`mkjava` | Accepts an argument for Java version and obtains that build from Adoptium | +`mkmp3tag` | Latest 64-bit Mp3tag release | +`mkmusikcube` | Latest musikcube release | +`mkmusl` | Latest musl.cc toolchain | +`mknode` | Latest official NodeJS release | +`mkpypy` | Latest PyPy3 release | +`mkrust` | Latest Rust nightly | `mksignal` | Latest Signal stable from the Solus repos (requires `eopkg` and may not work on other distros) | -`mktex ` | Minimal/custom TeX Live image | -`mkwine ` | Latest `wine-staging-tkg` release | +`mktex` | Minimal/custom TeX Live image | +`mkwine` | Latest `wine-staging-tkg` release | `mkwine proton` | GloriousEggroll Proton Builds | `rustsolus` | Latest Rust stable from the Solus repos (requires `eopkg` and may not work on other distros) |