Merge pull request #87 from pcengines/repo_cleanup

Repo cleanup

Author: pietrushnic

CHANGELOG.md

@@ -1,11 +1,11 @@
 Change log for PC Engines binary releases
 =========================================
 
-You can find recent changelogs in [release_manifest](https://github.com/pcengines/release_manifests)
+You can find changelogs for older releases in [release_manifest](https://github.com/pcengines/release_manifests)
 repository.
 
-Direct links:
+For newer releases please refer to the changelogs:
 
-* [mainline releases changelog](https://github.com/macpijan/release_manifests/blob/coreboot-4.5.x/CHANGELOG.md)
+* [mainline releases changelog](https://github.com/macpijan/release_manifests/blob/coreboot-4.6.x/CHANGELOG.md)
 
 * [legacy releases changelog](https://github.com/macpijan/release_manifests/blob/coreboot-4.0.x/CHANGELOG.md)

README.md

@@ -7,182 +7,34 @@ apuX platform users and developers to customize firmware to their needs.
 Binary releases
 ---------------
 
-Please take a look at changelog form more information:
+All information about firmware releases (including changes, fixes and known
+issues) are available on the PC Engines Github site:
+https://pcengines.github.io/
 
-* [v4.6.x changelog](https://github.com/pcengines/release_manifests/blob/coreboot-4.6.x/CHANGELOG.md)
-* [v4.5.x changelog](https://github.com/pcengines/release_manifests/blob/coreboot-4.5.x/CHANGELOG.md)
-* [v4.0.x changelog](https://github.com/pcengines/release_manifests/blob/coreboot-4.0.x/CHANGELOG.md)
-
-
-## Mainline
-
-### apu2
-
-* 2017-02-24 - [apu2 v4.5.5](http://pcengines.ch/file/apu2_v4.5.5.rom.tar.gz)
-* 2017-08-31 - [apu2 v4.6.1](http://pcengines.ch/file/apu2_v4.6.1.rom.tar.gz)
-
-### apu3
-
-* 2017-02-24 - [apu3 v4.5.5](http://pcengines.ch/file/apu3_v4.5.5.rom.tar.gz)
-* 2017-08-31 - [apu3 v4.6.1](http://pcengines.ch/file/apu3_v4.6.1.rom.tar.gz)
-
-### apu4
-
-* 2018-03-01 - [apu4 v4.6.7](https://cloud.3mdeb.com/index.php/s/IsWijTyWw8MFY2Y)
-
-### apu5
-
-* 2017-08-31 - [apu5 v4.6.1](http://pcengines.ch/file/apu5_v4.6.1.rom.tar.gz)
-
-## Legacy
-
-### apu2
-
-* 2017-08-31 - [apu2 v4.0.12](http://pcengines.ch/file/apu2_v4.0.12.rom.tar.gz)
-* 2017-07-21 - [apu2 v4.0.11](http://pcengines.ch/file/apu2_v4.0.11.rom.tar.gz)
-* 2018-03-01 - [apu2 v4.0.15](http://pcengines.ch/file/apu2_v4.0.15.rom.tar.gz)
-
-### apu3
+All the newest binaries can be found there.
 
-* 2017-08-31 - [apu3 v4.0.12](http://pcengines.ch/file/apu3_v4.0.12.rom.tar.gz)
-* 2017-07-21 - [apu3 v4.0.11](http://pcengines.ch/file/apu3_v4.0.11.rom.tar.gz)
-* 2018-03-01 - [apu3 v4.0.15](http://pcengines.ch/file/apu3_v4.0.15.rom.tar.gz)
 
-### apu5
+Also please take a look at changelogs:
 
-* 2017-08-31 - [apu5 v4.0.12](http://pcengines.ch/file/apu5_v4.0.12.rom.tar.gz)
-* 2018-03-01 - [apu5 v4.0.15](http://pcengines.ch/file/apu5_v4.0.15.rom.tar.gz)
-
-Building firmware using APU2 image builder
-------------------------------------------
-
-Please note this procedure covers building `v4.0.x` firmware, which is based on
-legacy code. Mainline firmware development is in progress more information can be found [here](http://pcengines.info/forums/?page=post&id=CAA8403D-7135-4EA1-8C7E-41C8B15C6246).
-
-Get APU2 image builder from [here](http://pcengines.ch/file/apu2_image_builder_v0.1.img.xz) (MD5 sum after decompression: a40ea9caff93c0218a745e0625e1292a).
-
-```
-User/pass: root/voyage
-```
-
-1. Unpack image:
-
-    ```sh
-    tar xf apu2_image_builder_v0.1.img.xz
-    ```
-
-2. write image to SD/mSATA/USB
-3. boot the APU2 board with this image
-4. run below commands
-
-    ```sh
-    cd
-    remountrw
-    export BR_NAME=coreboot-4.0.x
-    wget https://github.com/pcengines/coreboot/archive/${BR_NAME}.zip
-    unzip ${BR_NAME}.zip
-    cd coreboot-${BR_NAME}/
-    cp /xgcc/.xcompile . # this command setup toolchain
-    cp configs/pcengines_apu2.config .config
-    make -j$(nproc)
-    ```
-
-5. once done find the new firmware in the build folder (`build/coreboot.rom`)
-6. see [here](http://pcengines.ch/howto.htm#bios) for instructions on how to
-   flash the firmware
-
-Building iPXE
--------------
-
-```sh
-cd && cd coreboot-${BR_NAME}
-IPXE_PATH=payloads/external/ipxe
-git clone https://github.com/pcengines/ipxe $IPXE_PATH
-wget https://raw.githubusercontent.com/pcengines/apu2-documentation/master/ipxe/general.h -O $IPXE_PATH/src/config/local/general.h
-wget https://raw.githubusercontent.com/pcengines/apu2-documentation/master/ipxe/menu.ipxe -O $IPXE_PATH/src/menu.ipxe
-cd $IPXE_PATH/src
-make -j$(nproc) bin/8086157b.rom EMBED=./menu.ipxe
-```
-
-Feel free to customize `menu.pxe` and `local/general.h` to match your needs.
-
-Building sortbootorder
-----------------------
+* [v4.6.x changelog](https://github.com/pcengines/release_manifests/blob/coreboot-4.6.x/CHANGELOG.md)
+* [v4.5.x changelog](https://github.com/pcengines/release_manifests/blob/coreboot-4.5.x/CHANGELOG.md)
+* [v4.0.x changelog](https://github.com/pcengines/release_manifests/blob/coreboot-4.0.x/CHANGELOG.md)
 
-> coreboot is in `./coreboot-${BR_NAME}` directory
->
-```sh
-git clone https://github.com/pcengines/sortbootorder.git sortbootorder
-cd sortbootorder
-# for mainline coreboot (4.5.x)
-COREBOOT_ROOT=../coreboot-${BR_NAME} make distclean
-COREBOOT_ROOT=../coreboot-${BR_NAME} make
-# for legacy coreboot (4.0.x)
-COREBOOT_ROOT=../coreboot-${BR_NAME} make distclean
-COREBOOT_ROOT=../coreboot-${BR_NAME} COREBOOT_REL=legacy make
-```
 
-Building memtest86+
--------------------
 
-```sh
-cd && cd coreboot-${BR_NAME}
-git clone https://github.com/pcengines/memtest86plus.git payloads/external/memtest86plus
-cd payloads/external/memtest86plus
-make -j$(nproc)
-```
 
-cbfstool and adding/removing ROMs or payloads
----------------------------------------------
+Building firmware using PC Engines firmware builder
+---------------------------------------------------
 
-`cbfstool` is result of `coreboot` build it gives ability to manipulate CBFS
-which filesystem for coreboot ROM.
+Since releases v4.6.9 and v4.0.17 build process has been simplified.
+PC Engines firmware builder is a dedicated tool to build fully featured apu
+firmware binaries using separated docker environment. It provides users-friendly
+scripts that allow to build release and custom binaries. For more information
+and usage details please visit: https://github.com/pcengines/pce-fw-builder
 
-Usage examples:
-
-### Add iPXE ROM
+For releases older than v4.0.17 and v4.6.9 use the procedure described in this
+[document](docs/release_process.md)
 
-```sh
-cd && cd coreboot-${BR_NAME}
-./build/cbfstool ./build/coreboot.rom add -f payloads/external/ipxe/src/bin/8086157b.rom -n genroms/pxe.rom -t raw
-```
-
-Above command add raw image (`8086157b.rom`, result of iPXE build) to
-`coreboot.rom` under the name `genroms/pxe.rom`. This makes SeaBIOS to auto
-detect iPXE ROM and execute it before entering menu.
-
-### Add sortbootorder
-
-```
-# add sortbootorder
-cd && cd coreboot-${BR_NAME}
-./build/cbfstool ./build/coreboot.rom remove -n img/setup
-./build/cbfstool ./build/coreboot.rom add-payload -f payloads/pcengines/sortbootorder/sortbootorder.elf -n img/setup -t payload
-```
-
-Above commands first remove already existing `img/setup` from CBFS and then add
-`sortbootorder.elf` as payload under the name `img/setup` to `coreboot.rom`.
-
-
-### Add memtest86+
-
-```
-# add memtest86+
-cd && cd coreboot-${BR_NAME}
-./build/cbfstool ./build/coreboot.rom remove -n img/memtest
-./build/cbfstool ./build/coreboot.rom add-payload -f payloads/external/memtest86plus/memtest -n img/memtest - payload
-```
-
-Cross compilation in Docker container
----------------------------------------
-
-For advanced users and developers there maybe need to have development
-environment that is separated for working environment. Because of that you can
-use Docker containers as descried below.
-
-1. [Build container](docs/building_env.md)
-2. [Building firmware](docs/building_firmware.md)
-3. [Firmware flashing](docs/firmware_flashing.md)
 
 Other resources
 ----------------