summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNathan Rossi <nathan@nathanrossi.com>2016-05-16 18:38:24 +1000
committerNathan Rossi <nathan@nathanrossi.com>2016-05-17 19:33:48 +1000
commit056d9ab372ec553fae5b6c4e325cb39f811ec720 (patch)
tree955fb04c7de6fd29371e6a82cf7a20b3c3fe660d
parent5d58f1532855255858c5b29119fd997434e25187 (diff)
downloadmeta-xilinx-056d9ab372ec553fae5b6c4e325cb39f811ec720.tar.gz
README.md: Rework structure of README
Rework the structure of the README file reducing the content of the README and splitting it off into separate documentation files, adding references to the machines as well as the documentations files. Signed-off-by: Nathan Rossi <nathan@nathanrossi.com>
-rw-r--r--README.md76
1 files changed, 25 insertions, 51 deletions
diff --git a/README.md b/README.md
index 93f5c151..1a19c457 100644
--- a/README.md
+++ b/README.md
@@ -3,36 +3,39 @@ meta-xilinx
3 3
4This layer provides support for MicroBlaze, Zynq and ZynqMP. 4This layer provides support for MicroBlaze, Zynq and ZynqMP.
5 5
6Additional documentation:
7 * [Building](README.building.md)
8 * [Booting](README.booting.md)
9
6Supported Boards/Machines 10Supported Boards/Machines
7========================= 11=========================
8 12
9Boards Supported by this layer: 13Boards/Machines supported by this layer:
10 * Xilinx KC705 (MicroBlaze) 14 * MicroBlaze:
11 * Xilinx ZC702 (Zynq) 15 * [qemumicroblaze](conf/machine/qemumicroblaze.conf) - `qemumicroblaze`
12 * Xilinx ZC706 (Zynq) 16 * [qemumicroblaze-s3adsp1800](conf/machine/qemumicroblaze-s3adsp1800.conf) - `qemumicroblaze-s3adsp1800`
13 * Xilinx ZCU102 (ZynqMP) 17 * [Xilinx KC705](conf/machine/kc705-microblazeel.conf) - `kc705-microblazeel`
14 * Xilinx EP108 (ZynqMP) 18 * Zynq:
15 * Avnet/Digilent ZedBoard (Zynq) 19 * [qemuzynq](conf/machine/qemuzynq.conf) - `qemuzynq`
16 * Avnet MicroZed (Zynq) 20 * [Xilinx ZC702](conf/machine/zc702-zynq7.conf) - `zc702-zynq7`
17 * Avnet PicoZed (Zynq) 21 * [Xilinx ZC706](conf/machine/zc706-zynq7.conf) - `zc706-zynq7`
18 * Digilent Zybo (Zynq) 22 * [Avnet MicroZed](conf/machine/microzed-zynq7.conf) - `microzed-zynq7`
19 * Digilent Zybo Linux BD Reference Design (Zynq) 23 * [Avnet PicoZed](conf/machine/picozed-zynq7.conf) - `picozed-zynq7`
20 24 * [Avnet/Digilent ZedBoard](conf/machine/zedboard-zynq7.conf) - `zedboard-zynq7`
21QEMU Models Supported by this layer: 25 * [Digilent Zybo](conf/machine/zybo-zynq7.conf) - `zybo-zynq7`
22 * qemumicroblaze (MicroBlaze) 26 * [Digilent Zybo Linux BD](conf/machine/zybo-linux-bd-zynq7.conf) - `zybo-linux-bd-zynq7`
23 * qemumicroblazeeb-s3adsp1800 (MicroBlaze) 27 * ZynqMP:
24 * qemuzynq (Zynq) 28 * [Xilinx EP108](conf/machine/ep108-zynqmp.conf) - `ep108-zynqmp` (QEMU support)
25 * Xilinx EP108 (ZynqMP) 29 * [Xilinx ZCU102](conf/machine/zcu102-zynqmp.conf) - `zcu102-zynqmp`
26
27(Please refer to the associate .conf for more information)
28 30
29Additional information on Xilinx architectures can be found at: 31Additional information on Xilinx architectures can be found at:
30 http://www.xilinx.com/support/index.htm 32 http://www.xilinx.com/support/index.htm
31 33
32Maintainers, Patches/Submissions, Community 34Maintainers, Mailing list, Patches
33=========================================== 35==================================
34 36
35Please send any patches, pull requests, comments or questions for this layer to: 37Please send any patches, pull requests, comments or questions for this layer to
38the [meta-xilinx mailing list](https://lists.yoctoproject.org/listinfo/meta-xilinx):
36 39
37 meta-xilinx@lists.yoctoproject.org 40 meta-xilinx@lists.yoctoproject.org
38 41
@@ -50,32 +53,3 @@ This layer depends on:
50 URI: git://git.openembedded.org/openembedded-core 53 URI: git://git.openembedded.org/openembedded-core
51 layers: meta 54 layers: meta
52 55
53Build Instructions
54==================
55
56The following instructions require a Poky installation (or equivalent).
57
58Initialize a build using the 'oe-init-build-env' script in Poky. Once
59initialized configure bblayers.conf by adding the 'meta-xilinx' layer. e.g.:
60
61 BBLAYERS ?= " \
62 <path to layer>/oe-core/meta \
63 <path to layer>/meta-xilinx \
64 "
65
66To build a specific target BSP configure the associated machine in local.conf:
67
68 MACHINE ?= "zc702-zynq7"
69
70Build the target file system image using bitbake:
71
72 $ bitbake core-image-minimal
73
74Once complete the images for the target machine will be available in the output
75directory 'tmp/deploy/images'.
76
77Additional Documentation
78========================
79
80Additional documentation can be found in the 'docs/*' directory of this layer.
81