diff --git a/README_PINN.md b/README_PINN.md index 0567b509c..72edaca45 100644 --- a/README_PINN.md +++ b/README_PINN.md @@ -47,7 +47,7 @@ PINN is designed to make it easy to select and install operating systems for the Once PINN is installed on your SD card, the installation of other OSes and a lot of the maintenance of them can mostly be done on the RPi itself without having to remove the SD card. -The list of OSes that can be installed by PINN is growing all the time, from general purpose Linux distros, through educational versions, media centres to retro gaming solutions. It is the ideal environment to experiment and try out new OSes. +The list of OSes that can be installed by PINN is growing all the time, from general purpose Linux distros, through educational versions, media centers to retro gaming solutions. It is the ideal environment to experiment and try out new OSes. PINN occupies just over 60MB of your precious SD card space, leaving the majority of the card available for your OSes. @@ -168,7 +168,7 @@ OSes are grouped onto tabs which categorise the type of OS they are. This groupi Each OS has a checkbox at the left hand side to select whether it will be installed or not. When PINN is booted with OSes already installed, these OSes will normally have their checkbox automatically ticked (but see the `select` option) and their background will also be light green in colour, along with the word **[installed]** next to their name. Note that installed OSes may be selected in multiple tabs. -When the **Maintenance** toolbar is selected, this list will change to only show the list of OSes that are already installed, since the toolbar buttons are only relevent to installed OSes. +When the **Maintenance** toolbar is selected, this list will change to only show the list of OSes that are already installed, since the toolbar buttons are only relevant to installed OSes. ## Status Window @@ -262,7 +262,7 @@ If PINN detects you are using the [Raspberry Pi Touch Display](https://www.raspb ### How to use with Gert's VGA666 DPI display screen -The VGA666 adaptor connects to the GPIO pins and allows a VGA display to be attached to the RPi. The normal VGA666 installation instructions should be followed to allow it to work with PINN. +The VGA666 adapter connects to the GPIO pins and allows a VGA display to be attached to the RPi. The normal VGA666 installation instructions should be followed to allow it to work with PINN. Create a config.txt file with the following lines in it: ``` @@ -296,15 +296,15 @@ Params: rotate or rotate_0 Default orientation (landscape) Name: pimhyp4 Info: Overlay for activation of Pimoroni Hyperpixel 4" Load: dtoverlay=pimhyp4,[=] -Params: rotate or rotate_0 Default orientation (portrait) - rotate_1 Rotate 90 degrees CW (landscape) - rotate_2 Rotate 180 degrees (portrait) - rotate_3 Rotate 270 degrees (landscap) - checkonly Checks for presence of screen but does not load driver +Params: rotate or rotate_0 Default orientation (portrait) + rotate_1 Rotate 90 degrees CW (landscape) + rotate_2 Rotate 180 degrees (portrait) + rotate_3 Rotate 270 degrees (landscape) + checkonly Checks for presence of screen but does not load driver To rotate the screens, add `display_lcd_rotate=0` to config.txt. Replace the `0` with 1,2 or 3 for the various rotations. -To rotate the touchscreen add the appopriate dtparam to the overlay, e.g. `dtoverlay=pimhyp4:rotate_0` +To rotate the touchscreen add the appropriate dtparam to the overlay, e.g. `dtoverlay=pimhyp4:rotate_0` For some rotations, it may also be necessary to set the `framebuffer_width` and `framebuffer_height` parameters. Example config.txt files called config.hyp3 and config.hyp4 are included with example settings for each of the 4 rotations. @@ -327,7 +327,7 @@ Note 2: The `remotetimeout` option is useful to gain remote access within a time ### How to access the shell or SSH into PINN -1. Once the PINN GUI is launched, the busybox shell can be accessed by pressing CTRL-ALT-F2. Use the Username of `root` and password of `raspberry`. Use CTL-ALT-F1 to get back to the GUI. This can be useful for editing recovery.cmdline locally or performing other maintenance tasks on your SD card. +1. Once the PINN GUI is launched, the busybox shell can be accessed by pressing CTRL-ALT-F2. Use the Username of `root` and password of `raspberry`. Use CTRL-ALT-F1 to get back to the GUI. This can be useful for editing recovery.cmdline locally or performing other maintenance tasks on your SD card. 2. You can also SSH into the PINN basic busybox shell. To enable this feature, add `ssh` to the argument list in the `recovery.cmdline` file. SSH is also accessible from the rescueshell, but allow 5 seconds after boot to allow the network to establish. PINN generates host keys on first use, so it may take a little while to connect on the first attempt. @@ -355,7 +355,7 @@ You may now open a port in your router and map it to port 22 on your Pi to allow PINN's VNC cannot be secured directly, so do not expose the VNC port directly to the internet. However, if you have a secure SSH connection, it is possible to create a secure tunnel through SSH for VNC. The idea is to connect a local port on your client computer through the SSH tunnel to the VNC port (5900) on the RPi. -THic can be achieved with the following cmdline parameters to SSH: +This can be achieved with the following cmdline parameters to SSH: ``` ssh root@ -L :localhost:5900 e.g. @@ -378,7 +378,7 @@ Two editors are available in the recovery shell: vi and nano. Only the Tiny vers By default, PINN will output over HDMI at your display’s preferred resolution, even if no HDMI display is connected. If you do not see any output on your HDMI display or are using the composite output, press 1, 2, 3 or 4 on your keyboard to select HDMI preferred mode (1), HDMI safe mode (2), composite PAL mode (3), or composite NTSC mode (4), respectively. (Note that Composite mode is no longer available by default on the PI4 model) -From v3.5.2, PINN can automatically detect which of the 2 HDMI ports are connected and switch to using the correct one. If both are connected, it will ue HDMI 0. If the DSI touchscreen is attached, this will take precedence over the 2 HDMI ports. +From v3.5.2, PINN can automatically detect which of the 2 HDMI ports are connected and switch to using the correct one. If both are connected, it will use HDMI 0. If the DSI touchscreen is attached, this will take precedence over the 2 HDMI ports. If you don't have a keyboard, you can still change the display mode used by PINN through editing the `recovery.cmdline` file in the root PINN directory prior to first boot and appending the following argument: - `display=` (e.g. `display=1` or `display=3`) @@ -399,7 +399,7 @@ If a wired ethernet cable is plugged into the Pi before PINN starts, PINN will c ### Wireless Wifi Networks -If you have the official [Rapberry Pi USB wifi Dongle](https://www.raspberrypi.org/products/usb-wifi-dongle/), or are using the Raspberry Pi 3 Model B/B+ or Pi0W with built-in Wi-Fi, the Wi-Fi icon on the PINN toolbar will be available. Click on this to select your Wi-Fi SSID network and enter the Wi-Fi password. If the password is correct, you will soon be connected to the Internet and PINN will present a list of downloadable operating systems for you to install. +If you have the official [Raspberry Pi USB wifi Dongle](https://www.raspberrypi.org/products/usb-wifi-dongle/), or are using the Raspberry Pi 3 Model B/B+ or Pi0W with built-in Wi-Fi, the Wi-Fi icon on the PINN toolbar will be available. Click on this to select your Wi-Fi SSID network and enter the Wi-Fi password. If the password is correct, you will soon be connected to the Internet and PINN will present a list of downloadable operating systems for you to install. ![alt text](screenshots/wifi_selector.png "Select your Wi-Fi network and enter the password.") @@ -464,7 +464,7 @@ The following is a complete list of all the PINN options that can be added to th - **reserve=(+)NNN**: This option will reserve a set amount of space for PINN's partition (typically /dev/mmcblk0p1) when the `runinstaller` option first formats the SD card. This space may be useful for adding OS install files later, or for using the first partition as a transfer area for data between the RPi and a Windows PC that can only read the SD card's first partition. NNN specifies the total size of this partition in MB. The default value is around 64MB. If the size is prefixed with a '+' sign, the value indicates an amount of disk space to be reserved [i]in addition[/i] to the size of PINN's files. So, `reserve=200` will make P1 200MB in size and `reserve=+200` will make it about 263MB in size. -- **provision=NNN**: The `provision` option saves some space at the end of the drive that is not allocated to the extended partition that PINN creates for its OSes, when the `runinstaller` option formats the drive. The idea is that an SSD's firmware can make use of this space for over-allocation and wear-levelling to extend the life of the drive. (This option is not available in the Edit Options dialog.) +- **provision=NNN**: The `provision` option saves some space at the end of the drive that is not allocated to the extended partition that PINN creates for its OSes, when the `runinstaller` option formats the drive. The idea is that an SSD's firmware can make use of this space for over-allocation and wear-leveling to extend the life of the drive. (This option is not available in the Edit Options dialog.) - **no_update**: Prevents PINN from performing a self-update check on boot up. Use the `reinstall` option to manually check for updates on PINN. @@ -492,7 +492,7 @@ The following is a complete list of all the PINN options that can be added to th - **gpiochannel=\**: Allows a different GPIO pin to be specified to trigger the recovery menu. -- **gpiochannelValue=\**: This specifies the value the GPIO shoudl be set to to trigger the recovery menu. The default is 0. Specify 1 to trigger when the GPIO pin goes high. +- **gpiochannelValue=\**: This specifies the value the GPIO should be set to to trigger the recovery menu. The default is 0. Specify 1 to trigger when the GPIO pin goes high. - **keyboardtriggerdisable**: Prevents a `SHIFT` keypress from entering Recovery Mode on boot (maybe you have a problematic keyboard which is erroneously triggering every time you boot) @@ -519,9 +519,9 @@ In addition to specifying a list of OS names, some reserved words are also avail - **alt_image_source=\**: Provides the URL of an additional os_list_v3.json file indicating the location of other OSes that can be downloaded from the Internet. Multiple instances of this option can be used. -- **repo_list=\**: Provides the URL of a repo_list.json file that contains a list of URLs to other os-list_v3.json files. This allows easy remote management of Internet respositories. +- **repo_list=\**: Provides the URL of a repo_list.json file that contains a list of URLs to other os-list_v3.json files. This allows easy remote management of Internet repositories. -- **repo=\**: Similar to `alt_image_source` but it matches the NOOBS method of specifying a list of additional respositories as a space separated quoted string. +- **repo=\**: Similar to `alt_image_source` but it matches the NOOBS method of specifying a list of additional repositories as a space separated quoted string. - **no_default_source**: Prevents the default RaspberryPi Foundation repository from being used. @@ -607,7 +607,7 @@ PINN provides many options to customise the list of repositories that it will us - **repo=** option from NOOBS is supported by PINN. Using `repo` will replace the default RPF server repository, whereas `alt_image_source` simply adds a repository. To add multiple repositories add multiple space-separated urls to the single "quoted" repo option. -- **repo_list=** is used by default as it is a convenient way to support multiple repsositories by specifying one URL that points to a JSON file containing a list of other repositories. This makes it easier to maintain the OS list remotely for a set of users, rather than editing it manually on each Pi. For testing purposes, including a `repo_list.json` file on the PINN recovery partition will override any cmdline option and will be read instead. +- **repo_list=** is used by default as it is a convenient way to support multiple repositories by specifying one URL that points to a JSON file containing a list of other repositories. This makes it easier to maintain the OS list remotely for a set of users, rather than editing it manually on each Pi. For testing purposes, including a `repo_list.json` file on the PINN recovery partition will override any cmdline option and will be read instead. ## Local Images on SD card @@ -670,7 +670,7 @@ Once USB boot mode is enabled, proceed as follows: 1. Format the USB device as FAT 32 and copy the PINN files to it, just as you would for a normal PINN installation on an SD card. 2. Boot PINN on the Pi from the USB device. -3. Install your requried OSes as normal. +3. Install your required OSes as normal. ## Project Spaces @@ -776,7 +776,7 @@ To make use of the installation progress feature, a background shell script can If a script called /pinn_init.sh exists in PINN's recovery partition, it will be executed before PINN is started. This script will be mounted as /tmp/media/pinn_init.sh and must complete before PINN starts. It can be useful to initialise third party display drivers before the main PINN splash screen is shown. -The pinn_init.sh script is passed the boot drive as its frist parameter (e.g. /dev/sda1 or /dev/mmcblk0p1) +The pinn_init.sh script is passed the boot drive as its first parameter (e.g. /dev/sda1 or /dev/mmcblk0p1) --- @@ -832,7 +832,7 @@ NOTE: that once an `autoboot.txt` file is present, there's then no way to force ## Booting an OS directly from the recovery shell. -The ususal `reboot` command does not work in the PINN recovery shell. However, a new command `rebootp` has been added to allow this. By providing a partition number as an argument, it is possible to boot directly into one of the installed OSes directly. E.G. `reboot 6` will boot direclty into the OS installed in partition 6. There is also `rebootp.sh` which may be better to use from an ssh shell, as it provides a cleaner exit to the ssh terminal. +The usual `reboot` command does not work in the PINN recovery shell. However, a new command `rebootp` has been added to allow this. By providing a partition number as an argument, it is possible to boot directly into one of the installed OSes directly. E.G. `reboot 6` will boot directly into the OS installed in partition 6. There is also `rebootp.sh` which may be better to use from an ssh shell, as it provides a cleaner exit to the ssh terminal. --- @@ -852,13 +852,13 @@ The Info button will take you to the web page specific to the currently highligh ## Clear -The clear button will de-select any selected OSes either in the available or isntalled lists. On startup, PINN will auto-select any installed OSes, but this may be overridden +The clear button will de-select any selected OSes either in the available or installed lists. On startup, PINN will auto-select any installed OSes, but this may be overridden by the select option. In any case, this button provides a quick way of de-selecting all OSes in case you want to start afresh, without having to track them all down in the various tabs and windows. ## Exit -The Exit button (Esc) will exit recovery mode and go to the boot selection dialog, or directly boot the OS if only one is installed. The Exit button is ony enabled if bootable OSes have been installed. If only data partitions or ProjectSpaces have been installed, for example, then it will be greyed out. +The Exit button (Esc) will exit recovery mode and go to the boot selection dialog, or directly boot the OS if only one is installed. The Exit button is only enabled if bootable OSes have been installed. If only data partitions or ProjectSpaces have been installed, for example, then it will be greyed out. From p3.2.4 It is also possible to exit to the boot selection dialog from the other menus by pressing the Esc key, even though there is no toolbar button available. --- @@ -871,7 +871,7 @@ From p3.2.4 It is also possible to exit to the boot selection dialog from the ot As documented earlier, PINN can install an OS from a local USB disk instead of directly from the internet for use when no internet is available, or to avoid repetitive slow or costly downloads. But to do this, the OS and is accompanying meta-files must be downloaded from the internet to the USB drive. PINN's `download` feature allows this task to be done easily. It will only download OSes that are sourced from the network - selected OSes on a USB stick, for example, will be ignored. -You will be asked if you want to resume partial downloads. Only select this option if a previous download failed and you wnat to continue downloading the same file rather than starting again. Selecting Yes when no partial downloads are available could end up extending an existing file with a newer file, causing a problem. +You will be asked if you want to resume partial downloads. Only select this option if a previous download failed and you want to continue downloading the same file rather than starting again. Selecting Yes when no partial downloads are available could end up extending an existing file with a newer file, causing a problem. ![alt text](screenshots/download.png "Downloading OSes for offline use.") @@ -918,7 +918,7 @@ If a backup is attempted with no internet connection, this function will be call ## Reload Repos -If PINN cannot access the internet when it starts, it will not be able to download the lists of repositories or the OS distribution lists. Normally it will retry when the internet connection is restored, but in some circumstances this will not happen. If this is the case, the lsit of repositories and OS distribution lists can be reloaded manually through this option. +If PINN cannot access the internet when it starts, it will not be able to download the lists of repositories or the OS distribution lists. Normally it will retry when the internet connection is restored, but in some circumstances this will not happen. If this is the case, the list of repositories and OS distribution lists can be reloaded manually through this option.