Skip to content

Commit

Permalink
Updated readme with published examples and reinforced the suggestion …
Browse files Browse the repository at this point in the history
…to use a manifest-based build.
  • Loading branch information
Thomas Goodwin committed Jun 6, 2017
1 parent 2c00141 commit 97bac3f
Showing 1 changed file with 13 additions and 18 deletions.
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
meta-REDHAWK-SDR
=================

> **Note:** This is a distant fork of [Axios' layer](http://github.com/Axios-Engineering/openembedded-hawk) that was fairly far removed. Their copyright has been added to this copyright list along various recipes and pieces of their README. After a series of updates and changes it was different enough that it was pushed as a separate layer.
Meta-REDHAWK-SDR is an actively-maintained set of [Yocto][1]/[Open-Embedded][2] recipes for the [REDHAWK SDR][3] framework, its dependencies, and a handful of example Devices and shared libraries.

What is Yocto/Open-Embedded?
---------------------------
From the [Yocto][1] page itself:
This repository, along with the base Yocto framework will enable you to build the REDHAWK SDR framework for any hardware platform in which a Board Support Package is available. We at Geon have successfully used this layer on a variety of Zynq targets including:


>It's a complete embedded Linux development environment with tools, metadata, and documentation - everything you need. The free tools are easy to get started with, powerful to work with (including emulation environments, debuggers, an Application Toolkit Generator, etc.) and they allow projects to be carried forward over time without causing you to lose optimizations and investments made during the project’s prototype phase.
In short, [Yocto][1] allows you to build a custom, light weight embedded linux distribution built specifically for your hardware.

What is Meta-REDHAWK-SDR
--------------------------
Meta-REDHAWK-SDR is a set of [Yocto][1]/[Open-Embedded][2] recipes for the [REDHAWK][3] framework, its dependencies, and a handful of example components, devices, and shared libraries.

This repository, along with the base Yocto framework will enable you to build the REDHAWK framework for any hardware platform in which a Board Support Package is available.
* [ZC706 Evaluation Board](http://geontech.com/analog-devices-fmcomms-via-yocto/)
* [ZedBoard](https://youtu.be/pKpbkYB43js)
* [MicroZed](https://youtu.be/QvCrXl2cxpY)
* [Ettus Research E310](https://youtu.be/WSKZsSxtWsQ)
* iVeia Atlas-I-Z7e
* Several ZC702 -based designs

Is my hardware supported?
-------------------------
The Yocto website provides a list of [Official BSPs][4] which include common hardware platforms like the Raspberry Pi, BeagleBoard, BeagleBone, NUC, Intel Atom, etc.

There are plenty of BSPs floating around for other hardware platforms so do some searching before you write your own.

Use the Krogoth branch/version as your starting point for searching since it is the most recent version of Yocto that Geon has actively tested this layer against.

Getting Started
----------------

The most straight-forward installation is to use Google's repo and our [manifest](http://github.com/GeonTech/meta-redhawk-sdr-manifests). It amounts to a handful of terminal commands to `repo init` a manifest, which downloads the layers for a given configuration. Then running a terminal command to use our bblayers and local configuration files as templates. And finally, running bitbake. Instructions are provided at the link above.
### Learning By Example

The most straight-forward installation is to use Google's repo and a manifest. Complete instructions and our manifest [can be found here](http://github.com/GeonTech/meta-redhawk-sdr-manifests). The instructions amount to a handful of terminal commands that setup a known-good build as a starting point.

Alternatively, you can clone this layer into your own Yocto source tree:

Expand All @@ -50,8 +48,6 @@ Additional Resources

[Bitbake cheatsheet][8]

[OpenEmbedded-Hawk][9]

[1]: https://www.yoctoproject.org/ "Yocto Project Homepage"
[2]: http://www.openembedded.org/wiki/Main_Page "Open-Embedded Project Homepage"
[3]: http://redhawksdr.org "REDHAWK Homepage"
Expand All @@ -60,5 +56,4 @@ Additional Resources
[6]: http://www.yoctoproject.org/docs/current/yocto-project-qs/yocto-project-qs.html#packages "Required Packages"
[7]: http://www.yoctoproject.org/docs/latest/mega-manual/mega-manual.html "Yocto Mega Manual"
[8]: http://www.openembedded.org/wiki/Bitbake_cheat_sheet "Bitbake Cheat Sheet"
[9]: http://github.com/axios-engineering/openembedded-hawk "Axios' OpenEmbedded-Hawk"

0 comments on commit 97bac3f

Please sign in to comment.