ventoy-adamsdesk-theme/README.md

203 lines
7.2 KiB
Markdown

# Adamsdesk Ventoy Grub Theme
A simple Ventoy GNU Grub theme that mimics the website theme of [Adamsdesk.com](https://adamsdesk.com).
## Screenshots
### Main Menu
![Main Menu](screenshots/ventoy-ad-theme-main-menu.jpg)
### Memdisk
![Memdisk](screenshots/ventoy-ad-theme-memdisk.jpg)
### Power Menu
![Power Menu](screenshots/ventoy-ad-theme-power-menu.jpg)
### TreeView
![TreeView](screenshots/ventoy-ad-theme-treeview.jpg)
### Localboot Menu
![Localboot Menu](screenshots/ventoy-ad-theme-localboot-menu.jpg)
### Tools Menu
![Tools Menu](screenshots/ventoy-ad-theme-tools-menu.jpg)
### Grub Console
![Grub Console](screenshots/ventoy-ad-theme-console.jpg)
### Grub Boot Parameters
![Grub Boot Parameters](screenshots/ventoy-ad-theme-edit-params.jpg)
## Directory Structure
The directory structure listed below is in general terms and only those special files/directories are listed for
explanation purposes.
```console
.
├── screenshots/ < Screenshots of theme
├── src/ < Referenced source build files
├── ventoy/ < Temporary build directory
├── .gitignore < Git ignore configuration
├── build.sh < Build BASH script
├── CHANGELOG.md < Project change log
├── CONTRIBUTING.md < Project contributing guidelines
├── LICENSE < Project source code license
└── README.md < Project read me
```
## Development
### Assumptions
- Have an understanding of general Linux practices.
- Have experienced working knowledge within a CLI (command-line interface).
- Using a Linux operating system.
- Installed all required dependencies as stated in [System Requirements](#system-requirements) section.
- Installation is done via Linux CLI.
- Steps prefixed with a "$" (dollar sign) represents the CLI prompt. The text
after the "$" is to be entered at the CLI.
- Steps prefixed with a "#" (number sign) represents the CLI prompt with
elevated user permissions (e.g. root). The text after the "#" is to be entered
at the CLI.
- A single backslash character beside another character is used to escape the
proceeding character. In this case backslash character is not to to be entered
at the CLI.
- These instructions are an example of installation and configuration.
### System Requirements
- cp (GNU coreutils) v8.32
- find (GNU findutils) v4.7.0
- Git v2.30.0
- Inkscape v1.0.2 (e86c870879, 2021-01-15)
- mkdir (GNU coreutils) v8.32
- Ventoy v1.0.34
### Build Instructions
1. Download the project.
```console
$ git clone https://gitlab.com/adouglas/adamsdesk-ventoy-grub-theme.git
```
1. Change to project directory.
```console
$ cd adamsdesk-ventoy-grub-theme.git
```
1. Run build script.
```console
$ ./build.sh
```
```console
ventoy/
├── theme
│   └── adamsdesk
│   ├── adamsdesk.png
│   ├── icons
│   │   ├── alpinelinux.png
│   │   ├── archlinux.png
│   │   ├── cd.png
│   │   ├── debian.png
│   │   ├── deepin.png
│   │   ├── elementaryos.png
│   │   ├── fedora.png
│   │   ├── freedos.png
│   │   ├── gentoo.png
│   │   ├── kali.png
│   │   ├── kubuntu.png
│   │   ├── linuxmint.png
│   │   ├── linux.png
│   │   ├── lubuntu.png
│   │   ├── mageia.png
│   │   ├── manjaro.png
│   │   ├── openbsd.png
│   │   ├── opensuse.png
│   │   ├── solus.png
│   │   ├── ubcd.png
│   │   ├── ubuntu-budgie.png
│   │   ├── ubuntukylin.png
│   │   ├── ubuntu-mate.png
│   │   ├── ubuntu.png
│   │   ├── ubuntustudio.png
│   │   ├── windows.png
│   │   └── xubuntu.png
│   ├── select_c.png
│   ├── select_e.png
│   ├── select_w.png
│   ├── terminus-12.pf2
│   ├── terminus-14.pf2
│   ├── terminus-16.pf2
│   ├── terminus-18.pf2
│   └── theme.txt
└── ventoy.json
```
1. Copy build directory to desired Ventoy installation.
```console
$ cp -rp ventoy/ /mnt/usb/
```
## Attribution
I'm grateful for all the creators who have have openly licensed their work to make this project possible.
### Fonts
- [Terminus Font](https://sourceforge.net/projects/terminus-font/)
### Icons
- [Alpine Linux](https://www.svgrepo.com/svg/305688/alpinelinux)
- [Arch Linux](https://www.svgrepo.com/svg/305739/archlinux)
- [CD](https://www.svgrepo.com/svg/51861/compact-disc)
- [Debian](https://www.svgrepo.com/svg/305939/deepin)
- [Deepin](https://www.svgrepo.com/svg/305938/debian)
- [ElementaryOS](https://www.svgrepo.com/svg/305993/elementary)
- [Fedora](https://freebiesupply.com/logos/fedora-logo-2/)
- [FreeDOS](http://www.freedos.org/press-kit/logos.html)
- [Gentoo](https://www.svgrepo.com/svg/306090/gentoo)
- [Kali Linux](https://seeklogo.com/vector-logo/285900/kali-linux)
- [Kubuntu](https://commons.wikimedia.org/wiki/File:Kubuntu_logo.svg)
- [Linux Mint](https://www.svgrepo.com/svg/306345/linuxmint)
- [Linux Penguin](https://www.svgrepo.com/svg/306344/linux)
- [Lubuntu](https://commons.wikimedia.org/wiki/File:Lubuntu_logo_only.svg)
- [Mageia](https://commons.wikimedia.org/wiki/File:Mageia_logo.svg)
- [Manjaro](https://www.svgrepo.com/svg/306371/manjaro)
- [OpenBSD](https://www.svgrepo.com/svg/306507/openbsd)
- [openSUSE](https://www.svgrepo.com/svg/306517/opensuse)
- [Solus](https://www.svgrepo.com/svg/306754/solus)
- [Ubuntu Budgie](https://commons.wikimedia.org/wiki/File:Ubuntu_Budgie_No_Wordmark.svg)
- [Ubuntu Kylin](https://www.ubuntukylin.com/jintro/download.php?class1=464&lang=en) ([svg](https://www.ubuntukylin.com/public/images/version2019/images/UKlogo/5.svg))
- [Ubuntu Mate](https://commons.wikimedia.org/wiki/File:Ubuntu_MATE_rondel_logo.svg)
- [Ubuntu Studio](https://commons.wikimedia.org/wiki/File:Ubuntustudio_v3_logo_only.svg)
- [Ubuntu](https://www.svgrepo.com/svg/25424/ubuntu-logo)
- [Windows](https://www.svgrepo.com/svg/54206/windows)
- [Xubuntu](https://commons.wikimedia.org/wiki/File:Xubuntu_Icon.svg)
### Software
- [Git](https://git-scm.com/)
- [GNU Core Utilities](https://www.gnu.org/software/coreutils/)
- [GNU Findutils](https://www.gnu.org/software/findutils/)
- [GNU Grub](https://www.gnu.org/software/grub/)
- [Inkscape](https://inkscape.org/)
- [Ventoy](https://ventoy.net/)
## Copyright License
The copyright license (LICENSE) is only referring to the source code.
Adamsdesk logo Copyright (c) 2020 - 2021 Adam Douglas
All other logos / icons are copyright to those respected holders.
[Terminus Font](https://sourceforge.net/projects/terminus-font/) is licensed under the SIL Open Font License, Version
1.1. The license is included as OFL.TXT, and is also available with a FAQ at: https://scripts.sil.org/OFL