Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Goodwin committed Jan 10, 2017
1 parent 8776534 commit 74e47ee
Showing 1 changed file with 16 additions and 37 deletions.
53 changes: 16 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
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 with a large portion of the original README, and some recipes. After a series of updates and changes it was different enough that it was pushed as a separate layer.
> **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.
What is Yocto/Open-Embedded?
---------------------------
Expand All @@ -12,9 +12,9 @@ From the [Yocto][1] page itself:
In short, [Yocto][1] allows you to build a custom, light weight embedded linux distribution built specifically for your hardware.

What is Openembedded-Hawk
What is Meta-REDHAWK-SDR
--------------------------
Openembedded-hawk 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.
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.

Expand All @@ -27,46 +27,21 @@ There are plenty of BSPs floating around for other hardware platforms so do some
Getting Started
----------------

1. Install the required software listed in the [Yocto Quick Start Packages Section][6]
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.

2. Checkout the Yocto Poky repositories dizzy branch:
Alternatively, you can clone this layer into your own Yocto source tree:

git clone -b dizzy git://git.yoctoproject.org/poky.git
cd <your work director where other meta* are loaded>
git clone git://github.com/geontech/meta-redhawk-sdr.git

Then edit your `build/conf/bblayers.conf` to include a reference to `meta-redhawk-sdr` at the end of the list. See our `meta-redhawk-sdr/conf/bblayers.conf.sample` as an example.

3. Clone the openembedded-hawk repository inside the poky folder as meta-redhawk.

```
cd poky
git clone https://<server>/openembedded/meta-redhawk-sdr.git meta-redhawk
```
4. Source the build-env script
```
source oe-init-build-env
```
5. Pick a machine type within the conf/local.conf file. The default will build for an emulated x86 machine type.
6. Add REDHAWK recipes to the build image. The easiest way to do this is by using the conf/local.conf file and adding the IMAGE_INSTALL_append variable at the end. Here is an example that adds the core framework, frontend, and a GPP. Note that all the dependencies will automatically be built including redhawk-core
```
IMAGE_INSTALL_append = " redhawk-frontend redhawk-gpp"
```
6. Add the meta-redhawk directory to the BBLAYERS variable in conf/bblayers.conf so yocto knows where to search for our custom recipes.
7. Build an image:
```
bitbake core-image-minimal
```
Alternative Methods
Finishing the Build
-------------------

In the `contrib/scripts` folder is the `build-image.sh` script, a derivative of a script from Philip Balister of Ettus Research who included it with their `meta-sdr`. It uses `wic` to build a single image file that can be directly copied to an SD card (`dd`) resulting in the appropriate partitions, etc., buased on the associated `wks` file. Specify the `BUILD_IMAGE` and `MACHINE` environment variables and this script will go through the whole process for you, automated.
In the `contrib/scripts` folder is the `build-image.sh` script, a derivative of a script from Philip Balister (@balister) of Ettus Research who included it with their `meta-sdr`. The script uses `wic` to build a single image file that can be directly copied to an SD card (`dd`) resulting in the appropriate partitions, etc., based on the associated `wks` file.

To use it, link this script into your `build` directory, set it to executable, and specify the `BUILD_IMAGE` and `MACHINE` environment variables (e.g., `qemuarm` and `redhawk-gpp-image`). Then running this script will go through the whole bitbake process for you, automated.

Additional Resources
--------------------
Expand All @@ -75,6 +50,8 @@ 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 @@ -83,3 +60,5 @@ 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 74e47ee

Please sign in to comment.