From 4f48166502e3d0440bcd29e6a5565ee9a4a21db1 Mon Sep 17 00:00:00 2001 From: Brad Bishop Date: Thu, 19 Sep 2019 12:34:23 -0400 Subject: meta-aspeed: enhance README.md Add words to the layer README. The existing README is somewhat terse. Expand it some, adopting some of the conventions from other well-known OE BSP layers (used meta-freescale as a template). Drop references to specific products. This reduces maintainence burden. Added layer dependencies. meta-aspeed depends on oe-core only. Add contributing guidelines and style guide. (From meta-aspeed rev: 5e3e6fb63cbc700214fb3354363d93a5fa4246df) Change-Id: Ib4ec545c7fe5069893090516232fc2d9c666c2c8 Signed-off-by: Brad Bishop --- meta-aspeed/README.md | 45 ++++++++++++++++++++++++++++++++++++--------- 1 file changed, 36 insertions(+), 9 deletions(-) (limited to 'meta-aspeed') diff --git a/meta-aspeed/README.md b/meta-aspeed/README.md index 6c3221ef9..b97bbc78d 100644 --- a/meta-aspeed/README.md +++ b/meta-aspeed/README.md @@ -1,9 +1,36 @@ -ASPEED -================ - -This is the ASPEED Board Support Package (BSP) layer. It supports the -AST2400 and AST2500; ARM service management SOCs made by ASPEED. More -information about the AST2400 and AST2500 can be found -[here](https://www.aspeedtech.com/products.php?fPath=20&rId=376) -and -[here](https://www.aspeedtech.com/products.php?fPath=20&rId=440). +OpenEmbedded/Yocto BSP layer for Aspeed's platforms +====================================================================== + +This layer provides support for Aspeed's platforms for use with OpenEmbedded +and/or Yocto. + +``` +This layer depends on: + +URI: git://git.openembedded.org/openembedded-core +layers: meta +branch: master +revision: HEAD +``` + +Contributing +------------ + +meta-aspeed patches are reviewed using the Gerrit instance at +https://gerrit.openbmc-project.xyz. + +Please submit patches to Gerrit. More information on using Gerrit can be found +[here](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server). +https://github.com/openbmc/meta-aspeed is a hosting mirror only and GitHub +pull requests are not monitored and will not be accepted. + +Patch checklist. Please ensure patches adhere to the following guidelines: + + - meta-aspeed uses the [OE style + guidelines](https://www.openembedded.org/wiki/Styleguide). + - follow [the seven rules of a great git commit + message](https://chris.beams.io/posts/git-commit/#seven-rules) + +For questions or help please come join us on the [mailing +list](https://lists.ozlabs.org/listinfo/openbmc) or in +[IRC](irc://freenode.net/openbmc). -- cgit v1.2.3