From 3a061d84dfb2a3fb7b1ca92f467e1c87bb82b60e Mon Sep 17 00:00:00 2001 From: TRS-80 Date: Wed, 25 Nov 2020 18:04:21 -0500 Subject: [PATCH] Fix many broken links throughout Docs (reported in #113) There were a few minor things I cleaned up along the way, but mostly I tried to stick to just fixing links. --- docs/Community_IRC.md | 2 +- docs/Developer-Guide_Build-Process.md | 44 +++++++++++++++++---------- docs/Developer-Guide_FEL-boot.md | 4 ++- docs/Developer-Guide_Using-Vagrant.md | 2 +- docs/Hardware_Allwinner-A20.md | 4 +-- docs/Hardware_Allwinner-H6.md | 2 +- docs/Hardware_Allwinner.md | 19 ++++++++---- docs/Hardware_Freescale-imx6.md | 4 +-- docs/Hardware_Marvell.md | 8 ++--- docs/Process_Contribute.md | 6 ++-- docs/Process_Release-Model.md | 6 ++-- docs/Quick_facts.md | 2 +- docs/Release_Changelog.md | 26 ++++++++-------- docs/User-Guide_Advanced-Features.md | 6 +++- docs/User-Guide_Allwinner_overlays.md | 2 +- docs/User-Guide_Armbian-Config.md | 2 +- docs/User-Guide_Getting-Started.md | 10 +++--- docs/index.md | 4 +-- 18 files changed, 89 insertions(+), 64 deletions(-) diff --git a/docs/Community_IRC.md b/docs/Community_IRC.md index 3dd5457b..6901cf8b 100644 --- a/docs/Community_IRC.md +++ b/docs/Community_IRC.md @@ -75,7 +75,7 @@ If you cannot find yourself in the list above you are free to request an unaffil - Register your nick with Freenode's Nickserv service. Check [https://freenode.net/kb/answer/registration](https://freenode.net/kb/answer/registration) Even though it is not mandatory you should register and identify with the services as other channels for example may not allow unregistered users to chat or join at all as anti-spam measure. If the situation demands Armbian will enforce this as well. - *Why do some users have voice (+v) in channel?* - - As mentioned in [forums](https://forum.armbian.com/topic/12803-armbian-irc-channel/?do=findComment&comment=96828) "all contributors to the project, regardless if forums staff, contributor on Github or well known and longtime active user" may get voice on request. + - As mentioned in [forums](https://forum.armbian.com/topic/12803-armbian-irc-chat/?tab=comments#comment-96828) "all contributors to the project, regardless if forums staff, contributor on Github or well known and longtime active user" may get voice on request. - *Should I add __away__ to my nick if I am AFK? Like __Werner|away__* - No. Please use the `/away [reason]` command as intended. For an explanation please have a look at the [ZNC Wiki](https://wiki.znc.in/Awaynick).

diff --git a/docs/Developer-Guide_Build-Process.md b/docs/Developer-Guide_Build-Process.md index 9c812ede..ff1186cb 100644 --- a/docs/Developer-Guide_Build-Process.md +++ b/docs/Developer-Guide_Build-Process.md @@ -1,6 +1,6 @@ # What happens behind the build process? -### Build process summary: +## Build process summary: - creates development environment on top of amd64 Ubuntu 20.04 LTS, - downloads proven sources, applies patches on top and uses tested configurations, @@ -12,19 +12,23 @@ Check this image [compiling example](https://youtu.be/zeShf12MNLg) with partial cache. -### Build process details: +## Build process details: + +### Creating compile environment -## Creating compile environment ## First things first. All necessary dependencies are downloaded and installed. This happens though both http and torrent network. Btw. having too much unused traffic? [Help us to reduce ours :)](https://forum.armbian.com/topic/4198-seed-our-torrents/) -## Using board configuration ## +### Using board configuration + We need to get some predefined variables about selected the board. Which kernel & uboot source to use, modules to load, which is the build number, do we need to have a single partition or dual with boot on fat, which extra drivers to compile out of the kernel tree ... All this stuff is predefined for each and every single supported board. -## Downloading sources ## +### Downloading sources + When we know which sources to use and where they need to be the download or updated this process starts. This might take from several minutes to several hours. -## Patching ## +### Patching + In the patching process we are applying patches to the used sources. The process is - depending on selected board - defined in: lib/patch/kernel/sun7i-default @@ -36,7 +40,8 @@ In the patching process we are applying patches to the used sources. The process Patch rules for subdirectories are: **KERNEL_FAMILY-BRANCH** for kernel and **U-BOOT-SOURCE-BRANCH** for U-Boot. -## Debootstrap ## +### Debootstrap + Debootstrap creates fresh Debian / Ubuntu root filesystem templates or use cached under: output/cache/rootfs/ @@ -44,29 +49,36 @@ Debootstrap creates fresh Debian / Ubuntu root filesystem templates or use cache To recreate those files you need to remove them manually. From time to time they will be recreated anyway if Armbian updates their rootfs cache. -## Kernel install ## +### Kernel install + When the root filesystem is ready we need to install the kernel image with modules, board definitions and firmwares. Along with this we set the CPU frequency min/max, hostname, modules, network interfaces templates. Here is also the place to install headers and fix + native compile them on the way. -## Distribution fixes ## +### Distribution fixes + Each distribution has it's own way of doing things: - serial console - different packets - configuration locations -## Board fixes ## +### Board fixes + Each board has their own tricks: **different device names, firmware loaders, configuration (de)compilers, hardware configurators** -## Desktop installation ## +### Desktop installation + You can build a desktop environment withing the image. Consider this feature as experimental. Do not expect to have working hardware acceleration since this is a very complicated task and needs individial care for different boards. -## External applications ## +### External applications + This place is reserved for custom applications. There is one example of application: USB redirector. -## Closing image ## +### Closing image + There is an option to add some extra commands just before closing an image which is also automaticaly shrink to it's actual size with some small reserve. -## Directory structure ## +### Directory structure + It will be something like this: compile.sh compile execution script @@ -95,6 +107,6 @@ It will be something like this: userpatches/ put your kernel config here -## Additional info ## +## Additional info -- [Allwinner SBC community](https://linux-sunxi.org/) +- [Allwinner SBC community](https://linux-sunxi.org/Main_Page) diff --git a/docs/Developer-Guide_FEL-boot.md b/docs/Developer-Guide_FEL-boot.md index ea14abf2..aa655496 100644 --- a/docs/Developer-Guide_FEL-boot.md +++ b/docs/Developer-Guide_FEL-boot.md @@ -47,7 +47,9 @@ Because kernel and .bin/.dtb file are loaded from rootfs each time, it's possibl ## Advanced configuration -If you don't have DHCP server in your local network or if you need to alter kernel command line, use `lib/scripts/fel-boot.cmd.template` as a template and save modified script as `userpatches/fel-boot.cmd`. Check [this](https://git.kernel.org/cgit/linux/kernel/git/stable/linux-stable.git/plain/Documentation/filesystems/nfs/nfsroot.txt) for configuring static IP for NFS root +If you don't have DHCP server in your local network or if you need to alter kernel command line, use `lib/scripts/fel-boot.cmd.template` as a template and save modified script as `userpatches/fel-boot.cmd`. Check [this](https://git.kernel.org/cgit/linux/kernel/git/stable/linux-stable.git/plain/Documentation/filesystems/nfs/nfsroot.txt) for configuring static IP for NFS root. + +- Note: As of 2020-11-25, the above link is broken. However I am not sure what to replace it with. If you know (or find out) please [submit a PR](/Process_Contribute/). - TRS-80 Set `FEL_DTB_FILE` to relative path to .dtb or .bin file if it can't be obtained from u-boot config (mainline kernel) or boot/script.bin (legacy kernel) diff --git a/docs/Developer-Guide_Using-Vagrant.md b/docs/Developer-Guide_Using-Vagrant.md index 2a2d67de..f1b506d7 100644 --- a/docs/Developer-Guide_Using-Vagrant.md +++ b/docs/Developer-Guide_Using-Vagrant.md @@ -8,7 +8,7 @@ The following steps are performed on the *host* that runs Vagrant. #### Virtualbox Version -**WARNING:** We'll be using [Virtualbox as a virtualization provider for Vagrant](https://www.vagrantup.com/docs/virtualbox/). Virtualbox has [documented issues running Xenial under heavy disk IO](https://bugs.launchpad.net/cloud-images/+bug/1616794). Please make sure your version of Virtualbox is >= 5.1.12 where the issue, ["Storage: fixed a problem with the LsiLogic SCSI controller where requests could be lost with SMP guests"](https://www.virtualbox.org/wiki/Changelog), appears to have been resolved. +**WARNING:** We'll be using [Virtualbox as a virtualization provider for Vagrant](https://www.vagrantup.com/docs/providers/virtualbox/). Virtualbox has [documented issues running Xenial under heavy disk IO](https://bugs.launchpad.net/cloud-images/+bug/1616794). Please make sure your version of Virtualbox is >= 5.1.12 where the issue, ["Storage: fixed a problem with the LsiLogic SCSI controller where requests could be lost with SMP guests"](https://www.virtualbox.org/wiki/Changelog), appears to have been resolved. First, you'll need to [install Vagrant](https://www.vagrantup.com/downloads.html) on your host box. Next, you'll need to install a plug-in that will enable us to resize the primary storage device. Without it, the default Vagrant images are too small to build Armbian. diff --git a/docs/Hardware_Allwinner-A20.md b/docs/Hardware_Allwinner-A20.md index 045acd76..3b7ac6c5 100644 --- a/docs/Hardware_Allwinner-A20.md +++ b/docs/Hardware_Allwinner-A20.md @@ -10,13 +10,13 @@ Both *legacy* and *current* kernels are stable and production ready and mostly s - Enabled audio devices: analog, 8 channel HDMI, spdif and I2S (if wired and enabled in HW configuration) - Bluetooth ready (working with supported external keys) -- [Enabled overlayfs](User-Guide_Advanced-Features/#how-to-freeze-your-filesystem) +- [Enabled overlayfs](/User-Guide_Advanced-Features/#how-to-freeze-your-filesystem) - [I2C](https://en.wikipedia.org/wiki/I%C2%B2C) ready and tested with small 16×2 LCD. Basic i2c tools included. - SPI ready and tested with ILI9341 based 2.4″ TFT LCD display. - [Drivers for small TFT LCD](https://github.com/notro/fbtft) display modules. - [Clustering / stacking](https://en.wikipedia.org/wiki/Cluster_(computing)) - Onboard LED attached to SD card activity (script.bin) -- [Docker ready](User-Guide_Advanced-Features/#how-to-run-docker) +- [Docker ready](/User-Guide_Advanced-Features/#how-to-run-docker) - Enabled audio devices: analog, SPDIF (if available) & USB - [USB / UAS](https://linux-sunxi.org/USB/UAS) – more efficient disk access over USB (A20 and H3) - [CAN bus](https://en.wikipedia.org/wiki/CAN_bus) – Controller Area Network diff --git a/docs/Hardware_Allwinner-H6.md b/docs/Hardware_Allwinner-H6.md index f37d7ddd..29f6e1eb 100644 --- a/docs/Hardware_Allwinner-H6.md +++ b/docs/Hardware_Allwinner-H6.md @@ -21,4 +21,4 @@ Icenowy is working on a wrapper to make PCIe work. Check [forums](https://forum. ## Networking -Trouble getting ethernet connection? Check [here](https://forum.armbian.com/topic/9368-orangepi-3-h6-allwiner-chip/?do=findComment&comment=105682) +Trouble getting ethernet connection? Check [here](https://forum.armbian.com/topic/9368-orangepi-3-h6-allwiner-chip/page/32/?tab=comments#comment-105682) diff --git a/docs/Hardware_Allwinner.md b/docs/Hardware_Allwinner.md index ff492810..6292bb5a 100644 --- a/docs/Hardware_Allwinner.md +++ b/docs/Hardware_Allwinner.md @@ -69,15 +69,15 @@ Parameters regarding video must be saved into U-Boot environment file since they ### Connect your LCD display -I tried three different display connection types: I2C, (4bit) parallel and SPI. All of them are working perfectly with my image. I didn’t took a picture of the third one. It’s a standard Hitachi HD44780 based 20×4 LCD, wired and tested [according to Wiring(B)PI example](https://github.com/LeMaker/WiringBPi). +I tried three different display connection types: I2C, (4bit) parallel and SPI. All of them are working perfectly with my image. I didn’t took a picture of the third one. It’s a standard Hitachi HD44780 based 20×4 LCD, wired and tested [according to wiringBP example](https://github.com/LeMaker/WiringBP). -I2C +#### I2C ![](https://www.igorpecovnik.com/wp-content/uploads/2014/09/banana-i2c-display1.jpg) I am using [this code](https://github.com/vvromanov/cb_i2c_lcd) for mainline kernel and with [changed line](https://github.com/vvromanov/cb_i2c_lcd/blob/master/i2c_lcd.c#L28): /dev/i2c-%u = /dev/i2c-2 for Legacy kernel. -SPI +#### SPI ![](https://www.igorpecovnik.com/wp-content/uploads/2014/09/banana-spi-display.jpg) @@ -89,10 +89,13 @@ SPI - Reboot - Test – display some picture on the screen: `fbi -d /dev/fb2 -T 1 -noverbose -a yourimage.jpg` -- [Troubleshooting and settings for other displays -LVDS](https://github.com/notro/fbtft/wiki) -![](https://www.armbian.com/wp-content/uploads/2015/09/lvdsbanana.png) +#### LVDS + + Currently working only under Legacy kernel. @@ -110,6 +113,10 @@ If you need touch screen support, add this module to your /etc/modules `ft5x_ts` +#### Framebuffer + +[Linux Framebuffer drivers for small TFT LCD display modules.](https://github.com/notro/fbtft/wiki) + ## FEX (outdated/unsupported, informational only) ### Which file should I edit diff --git a/docs/Hardware_Freescale-imx6.md b/docs/Hardware_Freescale-imx6.md index 09fab195..d13a94c0 100644 --- a/docs/Hardware_Freescale-imx6.md +++ b/docs/Hardware_Freescale-imx6.md @@ -4,7 +4,7 @@ System images with legacy kernel - Kernel [3.14.x](https://github.com/linux4kix/linux-linaro-stable-mx6) with large hardware support, headers and some firmware included -- [Docker ready](https://forum.armbian.com/topic/490-docker-on-armbian/) – [what is Docker](https://www.docker.com/what-docker)? +- [Docker ready](https://forum.armbian.com/topic/490-docker-on-armbian/) – [what is Docker](https://www.docker.com/why-docker)? - PCI-E operational (Hummingboard Pro, Gate & Edge) - mSATA / m2 operational (Hummingboard Pro & Edge) - Enabled audio devices: HDMI, spdif, analogue @@ -22,7 +22,7 @@ System images with legacy kernel System images with mainline kernel - [Mainline](https://www.kernel.org/) with large hardware support, headers and some firmware included -- [Docker ready](User-Guide_Advanced-Features/#how-to-run-docker) – [what is Docker](https://www.docker.com/what-docker)? +- [Docker ready](/User-Guide_Advanced-Features/#how-to-run-docker) – [what is Docker](https://www.docker.com/what-docker)? - PCI-E operational (Hummingboard Pro, Gate & Edge) - mSATA / m2 operational (Hummingboard Pro & Edge) - Enabled audio devices diff --git a/docs/Hardware_Marvell.md b/docs/Hardware_Marvell.md index 9a47b3b9..9a1b40e4 100644 --- a/docs/Hardware_Marvell.md +++ b/docs/Hardware_Marvell.md @@ -22,11 +22,11 @@ All builds provide 100% hardware support for Helios4. * SDcard High Speed timing have compatibility issue with some brands.
Temporary workaround : Disable UHS option/support.
-Can be manually enable, refer to the following [page](https://wiki.kobol.io/sdcard). +Can be manually enable, refer to the following [page](https://wiki.kobol.io/sdcard) (2020-11-25 link broken [archive](https://web.archive.org/web/20191113071529/https://wiki.kobol.io/sdcard/)). * During SATA heavy load, accessing SPI NOR Flash will generate ATA errors.
Temporary workaround : Disable SPI NOR flash.
-Can be manually enable, refer to the following [page](https://wiki.kobol.io/spi). +Can be manually enable, refer to the following [page](https://wiki.kobol.io/spi) (2020-11-25 link broken [archive](https://web.archive.org/web/20191113071543/https://wiki.kobol.io/spi/)). ### Notes @@ -43,7 +43,7 @@ Both builds provide close to 100% hardware support, some slight differences are #### Legacy/Current - [Mainline kernel](https://www.kernel.org/) with large hardware support, headers and some firmware included -- [Docker ready](User-Guide_Advanced-Features/#how-to-run-docker) +- [Docker ready](/User-Guide_Advanced-Features/#how-to-run-docker) - Both mPCIe are operational and [convertible to mSATA](#converting-mpcie-to-msata), M2 operational - Added patch to unlock Atheros regulatory restrictions which unlock 5Ghz AP mode in cheap Atheros cards (ath9 driver) - Bluetooth ready (working with supported external keys) @@ -58,7 +58,7 @@ Both builds provide close to 100% hardware support, some slight differences are ### Converting mPCIe to mSATA -- To convert mPCIe to mSATA you have to enable the corresponding patches in [u-boot-mvebu](https://github.com/armbian/build/tree/master/patch/u-boot/u-boot-mvebu). Afterwards rebuild u-boot with our build system and write the new u-boot to your boot medium. If you need assistance ask in the forum. +- To convert mPCIe to mSATA you have to enable the corresponding patches in [u-boot-mvebu](https://github.com/armbian/build/tree/master/patch/u-boot/u-boot-mvebu-dev). Afterwards rebuild u-boot with our build system and write the new u-boot to your boot medium. If you need assistance ask in the forum. ### Notes diff --git a/docs/Process_Contribute.md b/docs/Process_Contribute.md index f1735b9f..6921905b 100644 --- a/docs/Process_Contribute.md +++ b/docs/Process_Contribute.md @@ -2,13 +2,13 @@ ## How? -1. [Fork](https://help.github.com/articles/fork-a-repo/) the project +1. [Fork](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) the project. 1. Make one or more well commented and clean commits to the repository. -1. Perform a [pull request](https://help.github.com/articles/creating-a-pull-request/) in Github's web interface. +1. Perform a [pull request](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) in Github's web interface. If it is a new feature request, do not start the coding first. Remember to [open an issue](https://guides.github.com/features/issues/) to discuss the new feature. -If you are struggling, check [WEB](https://www.exchangecore.com/blog/contributing-concrete5-github/) or [CLI](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) step-by-step guide on contributing. +If you are struggling, check [WEB](https://www.exchangecore.com/blog/contributing-concrete5-github) or [CLI](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) step-by-step guide on contributing. ## Where are the sources? diff --git a/docs/Process_Release-Model.md b/docs/Process_Release-Model.md index 7b0b49c4..e363010c 100644 --- a/docs/Process_Release-Model.md +++ b/docs/Process_Release-Model.md @@ -136,8 +136,8 @@ Testing Tracking Sheet: https://example.com/link (google sheets) The goal of this thread is to discuss testing, bugfixes, and the overall quality of the release. Once the release is complete, this thread should be locked and unpinned. ``` -- Before Code Freeze -- Make note in the thread the incomplete jira issues tagged for the release [example](https://forum.armbian.com/topic/12763-armbian-2002-chiru-release-thread/?do=findComment&comment=93245) -- After test images are procuded, engage in community for assistants wih testing.. forums, twitter, etc. [share this tool](https:///github.com/armbian/autotests) +- Before Code Freeze -- Make note in the thread the incomplete jira issues tagged for the release [example](https://forum.armbian.com/topic/12763-armbian-2002-chiru-release-thread/?tab=comments#comment-93245) +- After test images are procuded, engage in community for assistants wih testing.. forums, twitter, etc. [share this tool](https://github.com/armbian/autotests) ### 2. Release Candidate Branch Management @@ -164,7 +164,7 @@ The goal of this thread is to discuss testing, bugfixes, and the overall quality ## Release Testing -See [Opportunties for improvement](#Opportunities_for_Improvement) +See [Opportunties for improvement](#opportunities-for-improvement) ## Reflection on Prior Releases diff --git a/docs/Quick_facts.md b/docs/Quick_facts.md index 2a1217cb..7448f72a 100644 --- a/docs/Quick_facts.md +++ b/docs/Quick_facts.md @@ -50,4 +50,4 @@ Deep understanding how boards work, how operating system work and how hardware s ### Open -Open source build script and kernel development, maintenance and distribution for more than [30 different ARM and ARM64 Linux kernels](https://www.armbian.com/kernel). Powerful build and software development tools. Can run in fully parallel mode. Can run under Docker. +Open source build script and kernel development, maintenance and distribution for more than [30 different ARM and ARM64 Linux kernels](https://www.armbian.com/kernel/). Powerful build and software development tools. Can run in fully parallel mode. Can run under Docker. diff --git a/docs/Release_Changelog.md b/docs/Release_Changelog.md index 1455c60b..cfd974dc 100644 --- a/docs/Release_Changelog.md +++ b/docs/Release_Changelog.md @@ -955,7 +955,7 @@ Known bugs: **v5.54 / 25.7.2018** - updated images for Odroid C2, Nanopi M3, Nanopi Fire 3 and NanoPC T3+, Espressobin, Cubox-i/HB and Le potato -- added preview images without end user support for [Bananapi M3](https://dl.armbian.com/bananapim3/),[Cubietruck+](https://dl.armbian.com/cubietruckplus/) and [Bananapi M2 Berry](https://dl.armbian.com/bananapim2ultra/). +- added preview images without end user support for [Bananapi M3](https://www.armbian.com/bananapi-m3/),Cubietruck+ and [Bananapi M2 Berry](https://www.armbian.com/bananapi-m2u/). **v5.53 / 23.7.2018** @@ -1248,7 +1248,7 @@ Desktop images: - WICD was replaced with NetworkManager - ALSA was replaced with PulseAudio -- sunxi boards: [GLshim](https://github.com/ptitSeb/glshim) was added to desktop images with Mali support (except for Orange Pi Plus and Orange Pi Plus 2e) +- sunxi boards: [GLshim](https://github.com/ptitSeb/gl4es) was added to desktop images with Mali support (except for Orange Pi Plus and Orange Pi Plus 2e) - sunxi boards: prebuilt mpv now supports OSD and subtitles, activated by setting environment variable `VDPAU_OSD=1` Build script: @@ -1331,24 +1331,24 @@ Images: - all 3.10+ kernels [are Docker ready](https://forum.armbian.com/topic/490-docker-on-armbian/) - all A10/A20/H3 comes with HW accelerated video playback in desktop build -- [fixed root exploit on H3 boards](https://github.com/igorpecovnik/lib/issues/282) -- [fixed kswapd 100% bug on H3 boards](https://github.com/igorpecovnik/lib/issues/219) +- [fixed root exploit on H3 boards](https://github.com/armbian/build/issues/282) +- [fixed kswapd 100% bug on H3 boards](https://github.com/armbian/build/issues/219) - fixed SPDIF / I2S audio driver in legacy kernel - fixed Udoo Neo wireless - fixed slow SD cards boot - fixed Allwinner SS driver - fixed bluetooth on Cubietruck, both kernels - fixed wireless driver on H3 boards -- [fixed R1 switch driver](https://github.com/igorpecovnik/lib/commit/94194dc06529529015bfd04767865bbd04d29d9b) +- [fixed R1 switch driver](https://github.com/armbian/build/commit/94194dc06529529015bfd04767865bbd04d29d9b) - kernel for Allwinner boards was upgraded to 3.4.112 & 4.5.2 - kernel for iMx6 boards was upgraded to 3.14.67 & 4.5.2 - kernel for Armada (Clearfog) was upgraded to 3.10.101 & 4.5.2 - kernel for Udoo boards was updated to 3.14.67 & 4.4.8 - kernel for Guitar (Lemaker) was upgraded to 3.10.101 - kernel for H3/sun8i legacy come from new Allwinner updated source (friendlyarm) -- [added support for Olimex Lime2 eMMC](https://github.com/igorpecovnik/lib/issues/258) -- [increased MALI clockspeed on sun8i/legacy](https://github.com/igorpecovnik/lib/issues/265) -- added [Armbianmonitor](https://forum.armbian.com/topic/881-prepare-v51-v201604/?p=7095) +- [added support for Olimex Lime2 eMMC](https://github.com/armbian/build/issues/258) +- [increased MALI clockspeed on sun8i/legacy](https://github.com/armbian/build/issues/265) +- added [Armbianmonitor](https://forum.armbian.com/topic/881-prepare-v51-v201604/?tab=comments#comment-7095) - added Odroid C1, C2(arm64), Nanopi M1, Banana M2+, Pcduino 2 and Pcduino 3. CLI and desktop - added wifi radar to desktop - added preview mainline kernel images for H3 boards (4.6.RC1) @@ -1414,8 +1414,8 @@ Known bugs: - HDMI/DVI works (bug in boot.cmd settings) - Reboot issues fixed (bug in fex settings) -- 1-Wire useable (we chose to stay compatible to loboris' images so the data pin is 37 by default. You're able to change this in the [fex file](https://github.com/igorpecovnik/lib/blob/6d995e31583e5361c758b401ea44634d406ac3da/config/orangepiplus.fex#L1284-L1286)) -- changing display resolution and choosing between HDMI and DVI is now possible with the included _h3disp_ tool (should also work in the [stand-alone version](https://forum.armbian.com/topic/617-wip-orange-pi-one-support-for-the-upcoming-orange-pi-one/?p=5480) with Debian based OS images from loboris/Xunlong). Use `sudo h3disp` in a terminal to get the idea. +- 1-Wire useable (we chose to stay compatible to loboris' images so the data pin is 37 by default. You're able to change this in the [fex file](https://github.com/armbian/build/blob/6d995e31583e5361c758b401ea44634d406ac3da/config/orangepiplus.fex#L1284-L1286)) +- changing display resolution and choosing between HDMI and DVI is now possible with the included _h3disp_ tool (should also work in the [stand-alone version](https://forum.armbian.com/topic/617-wip-orange-pi-one-support-for-the-upcoming-orange-pi-one/page/6/?tab=comments#comment-5480) with Debian based OS images from loboris/Xunlong). Use `sudo h3disp` in a terminal to get the idea. - Ethernet issues fixed (combination of kernel and fex fixes) - USB-to-SATA bridge on the Orange Pi Plus works - stability problems on Orange Pi One fixed (due to undervoltage based on wrong fex settings) @@ -1441,7 +1441,7 @@ Known bugs: **v5.01 / 17.2.2016** - Bugfix update for [Allwinner boards](https://forum.armbian.com/topic/691-banana-pro-testers-wanted-sata-drive-not-working-on-some-boards/) -- Update [for H3 based boards](https://github.com/igorpecovnik/lib/commit/c93d7dfb3538c36739fb8841bd314d75e7d7cbe5) +- Update [for H3 based boards](https://github.com/armbian/build/commit/c93d7dfb3538c36739fb8841bd314d75e7d7cbe5) **v5.00 / 12.2.2016** @@ -1450,7 +1450,7 @@ Known bugs: - added Marvel Armada kernel 3.10.96, 4.4.1 and patches for changing mPCI to SATA - added Cubox / Hummingboard kernel 4.4.1 (serial console only) - firstrun does autoreboot only if needed: wheezy and some legacy kernels. -- [added motd](https://forum.armbian.com/topic/602-new-motd-for-ubuntudebian/#entry4223) to /etc/updated.motd ... redesign, added battery info for Allwinner boards, bugfix, coloring +- [added motd](https://forum.armbian.com/topic/602-new-motd-for-ubuntudebian/?do=findComment&comment=4223) to /etc/updated.motd ... redesign, added battery info for Allwinner boards, bugfix, coloring - fixed temperature reading on Cubox / Hummingboard legacy kernel - fixed FB turbo building on Allwinner - fixed NAND install on A10 boards (Legacy kernel only) @@ -1458,7 +1458,7 @@ Known bugs: - fixed Banana PRO/+ onboard wireless on mainline kernel - running with normal Banana DT. - readded USB sound - added [A13 Olimex SOM](https://www.olimex.com/Products/SOM/A13/A13-SOM-512/) -- added [LIRC GPIO receive and send driver](https://github.com/igorpecovnik/lib/issues/135) for legacy Allwinner +- added [LIRC GPIO receive and send driver](https://github.com/armbian/build/issues/135) for legacy Allwinner - added LED MMC activity to mainline kernels for Cubietruck and Cubieboard A10 - build script: option to build images with F2FS root filesystem for Allwinner boards - build script: added alternative kernel for Lemaker Guitar (NEXT), Cubox (DEV) diff --git a/docs/User-Guide_Advanced-Features.md b/docs/User-Guide_Advanced-Features.md index 61feed54..4cdd66b2 100644 --- a/docs/User-Guide_Advanced-Features.md +++ b/docs/User-Guide_Advanced-Features.md @@ -133,7 +133,11 @@ Required conditions: - IR hardware - loaded driver -Get your [remote configuration](https://lirc.sourceforge.net/remotes/) (lircd.conf) or [learn](https://kodi.wiki/view/HOW-TO:Setup_Lirc#Learning_Commands). You are going to need the list of all possible commands which you can map to your IR remote keys: +Get your [remote configuration](https://lirc.sourceforge.net/remotes/) (lircd.conf) or [learn](https://kodi.wiki/view/HOW-TO:Setup_Lirc#Learning_Commands). + +- Note: As of 2020-11-25, the above (Kodi / learn) link is broken. However I am not sure what to replace it with. If you know (or find out) please [submit a PR](/Process_Contribute/). - TRS-80 + +You are going to need the list of all possible commands which you can map to your IR remote keys: irrecord --list-namespace diff --git a/docs/User-Guide_Allwinner_overlays.md b/docs/User-Guide_Allwinner_overlays.md index 555cbf9d..03813b62 100644 --- a/docs/User-Guide_Allwinner_overlays.md +++ b/docs/User-Guide_Allwinner_overlays.md @@ -29,7 +29,7 @@ Please note that different SoCs will have different sets of available overlays. ## Using custom overlays -1. Check [here](https://github.com/zador-blood-stained/sunxi-DT-overlays-armbian/tree/master/examples) for some example overlays +1. Check [here](https://github.com/armbian/sunxi-DT-overlays/tree/master/examples) for some example overlays 2. Copy or create your overlay file (with `.dts` extension) on the device 3. Change I2C or SPI bus number, GPIO and pinctrl pins, `compatible` string to match your SoC if necessary 4. Compile and activate the overlay by running `armbian-add-overlay ` as root, i.e. `sudo armbian-add-overlay sht15.dts` diff --git a/docs/User-Guide_Armbian-Config.md b/docs/User-Guide_Armbian-Config.md index 932f11f8..b554364a 100644 --- a/docs/User-Guide_Armbian-Config.md +++ b/docs/User-Guide_Armbian-Config.md @@ -63,7 +63,7 @@ Software installation menu provides automated install of the following packages. - [Sonarr](https://sonarr.tv/) *(TV shows downloading server)* - [Transmission](https://transmissionbt.com/) *(torrent server)* - [ISPConfig](https://www.ispconfig.org/) *(WEB & MAIL server)* - - [NCP](https://nextcloudpi.com) *(Nextcloud personal cloud)* + - [NCP](https://ownyourbits.com/nextcloudpi/) *(Nextcloud personal cloud)* - [Openmediavault NAS](https://www.openmediavault.org/) *(NAS server)* - [PI hole](https://pi-hole.net) *(ad blocker)* - [UrBackup](https://www.urbackup.org/) *(client/server backup system)* diff --git a/docs/User-Guide_Getting-Started.md b/docs/User-Guide_Getting-Started.md index 8b419d16..37c9bb55 100644 --- a/docs/User-Guide_Getting-Started.md +++ b/docs/User-Guide_Getting-Started.md @@ -74,7 +74,7 @@ It is safe to ignore the message `WARNING: This key is not certified with a trus Since it might happen that your download got somehow corrupted we integrate a checksum/hash for the image. You can compare the image's SHA-256 hash with the one contained in the `sha256sum.sha` file. -On Windows, you can download and use the [QuickHash GUI](https://quickhash-gui.org/download/quickhash-v3-1-0-windows/) and follow the instructions in the gui. +On Windows, you can download and use the [QuickHash GUI](https://www.quickhash-gui.org/download/quickhash-v3-1-0-windows/) and follow the instructions in the gui. while on Linux/macOS, in the directory in which you have downloaded the files ,you would do this @@ -84,9 +84,9 @@ while on Linux/macOS, in the directory in which you have downloaded the files ,y ## How to prepare a SD card? -**Important note:** Make sure you use a **good, reliable and fast** SD card. If you encounter boot or stability troubles in over 95 percent of the time it is either insufficient power supply or related to SD card (bad card, bad card reader, something went wrong when burning the image, card too slow to boot -- 'Class 10' highly recommended!). Armbian can simply not run on unreliable hardware so checking your SD card with either [F3](https://oss.digirati.com.br/f3/) or [H2testw](https://www.heise.de/download/h2testw.html) is mandatory if you run in problems. Since [counterfeit SD cards](https://www.happybison.com/reviews/how-to-check-and-spot-fake-micro-sd-card-8/) are still an issue checking with F3/H2testw directly after purchase is **highly recommended**. +**Important note:** Make sure you use a **good, reliable and fast** SD card. If you encounter boot or stability troubles in over 95 percent of the time it is either insufficient power supply or related to SD card (bad card, bad card reader, something went wrong when burning the image, card too slow to boot -- 'Class 10' highly recommended!). Armbian can simply not run on unreliable hardware so checking your SD card with either [F3](https://oss.digirati.com.br/f3/) or [H2testw](https://www.heise.de/download/product/h2testw-50539) is mandatory if you run in problems. Since [counterfeit SD cards](https://www.happybison.com/reviews/how-to-check-and-spot-fake-micro-sd-card-8/) are still an issue checking with F3/H2testw directly after purchase is **highly recommended**. -Write the xz compressed image with [USBImager](https://gitlab.com/bztsrc/usbimager) or [Etcher](https://balena.io/etcher) on all platforms since unlike other tools, either can validate burning results **saving you from corrupted SD card contents**. +Write the xz compressed image with [USBImager](https://gitlab.com/bztsrc/usbimager) or [Etcher](https://balena.io/etcher/) on all platforms since unlike other tools, either can validate burning results **saving you from corrupted SD card contents**. Also important: Most SD cards are only optimised for sequential reads/writes as it is common with digital cameras. This is what the *speed class* is about. The SD Association defined [*Application Performance Class*](https://www.sdcard.org/developers/overview/application/index.html) as a standard for random IO performance. @@ -99,7 +99,7 @@ At the time of this writing A1 and A2 cards are only widely available from SanDi ![a1-16gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-ultra-a1.png) ![a1-32gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-extremepro-a1.png) ![a2-64gb-card](https://raw.githubusercontent.com/armbian/documentation/master/docs/images/sandisk-extreme-a2.png) -In case you chose an SD card that was already in use before please consider resetting it back to 'factory default' performance with [SD Formatter](https://www.sdcard.org/downloads/formatter_4/) before burning Armbian to it ([explanation in the forum](https://forum.armbian.com/topic/3776-the-partition-is-not-resized-to-full-sd-card-size/&do=findComment&comment=27413)). Detailed information regarding ['factory default' SD card performance](https://forum.armbian.com/topic/954-sd-card-performance/?page=3&tab=comments#comment-49811). +In case you chose an SD card that was already in use before please consider resetting it back to 'factory default' performance with [SD Formatter](https://www.sdcard.org/downloads/formatter/) before burning Armbian to it ([explanation in the forum](https://forum.armbian.com/topic/3776-the-partition-is-not-resized-to-full-sd-card-size/&do=findComment&comment=27413)). Detailed information regarding ['factory default' SD card performance](https://forum.armbian.com/topic/954-sd-card-performance/?page=3&tab=comments#comment-49811). ## How to boot? @@ -170,7 +170,7 @@ and you can choose the following file system options: * ext2,3,4 * btrfs -On Allwinner devices after switching to boot from NAND or eMMC clearing the boot loader signature on the SD card is recommended: `dd if=/dev/zero of=/dev/mmcblkN bs=1024 seek=8 count=1` (replace `/dev/mmcblkN` with the correct device node -- in case you run this directly after `nand-sata-install` without a reboot in between then it's `/dev/mmcblk0`). When booting from eMMC to get SD cards auto-detected on Allwinner legacy images please consider changing `mmc0`'s `sdc_detmode` from 3 to 1 in the board's fex file (see [here](https://forum.armbian.com/topic/1702-orange-pi-plus-2e-where-is-16ghz-and-sd/?p=13163) for details). +On Allwinner devices after switching to boot from NAND or eMMC clearing the boot loader signature on the SD card is recommended: `dd if=/dev/zero of=/dev/mmcblkN bs=1024 seek=8 count=1` (replace `/dev/mmcblkN` with the correct device node -- in case you run this directly after `nand-sata-install` without a reboot in between then it's `/dev/mmcblk0`). When booting from eMMC to get SD cards auto-detected on Allwinner legacy images please consider changing `mmc0`'s `sdc_detmode` from 3 to 1 in the board's fex file (see [here](https://forum.armbian.com/topic/1702-orange-pi-plus-2e-where-is-16ghz-and-sd/?tab=comments#comment-13163) for details). ## How to connect to wireless? diff --git a/docs/index.md b/docs/index.md index 681de575..414e1cfc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -89,8 +89,8 @@ If you still cannot find what you need here visit the [_Armbian forum_](https:// Check [download page](https://www.armbian.com/download/) for recently supported list. # Get Involved! # -* [Contribute](Process_Contribute) -* [Community](https://forum.armbian.com) +* [Contribute](Process_Contribute/) +* [Community](https://forum.armbian.com/) * [Contact](https://www.armbian.com/contact/) Our IRC channel is [#armbian](https://webchat.freenode.net/?channels=armbian) on [freenode](https://freenode.net/). More details [here](https://docs.armbian.com/Community_IRC/)