Commit Graph

27 Commits

Author SHA1 Message Date
Jan Vermaete
c4cb89e7c1 README.md: added how to set the machine when using Kas
Some checks failed
Mirrors / Yocto Git Mirror (push) Has been cancelled
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
2025-05-10 18:50:05 -07:00
Victor Löfgren
f44832bcdd README.md: Update link to compatible layers
Some checks failed
Mirrors / Yocto Git Mirror (push) Has been cancelled
The previous link pointing to Yocto Project Compatible Layers was no
longer valid.

Signed-off-by: Victor Löfgren <victor.l0fgr3n@gmail.com>
2024-09-09 13:59:04 +01:00
Jan Vermaete
065d5a457f README.md: pi3-disable-bt is renamed to disable-bt in kas example
Some checks are pending
Mirrors / Yocto Git Mirror (push) Waiting to run
in commit 01b162388e
with commit message:

  rpi-base: Drop old dtbo names

  pi3-disable-bt is renamed to disable-bt and pi3-miniuart-bt is renamed
  to miniuart-bt in 2014, now with 5.4 these are not recognised anymore
  and miniuart-bt and disable-bt are already part of RPI_KERNEL_DEVICETREE_OVERLAYS

Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
2024-07-17 22:16:29 +01:00
Andrei Gherzan
3bef4f04cc README.md: Refactor top table
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
2022-07-31 02:18:20 +01:00
Andrei Gherzan
d9ea8f66d9 README.md: Mention Yocto Compatible Layer
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
2022-07-31 02:18:20 +01:00
Jan Vermaete
3a91ee04eb docs: link to latest documentation of kas
Version 1.0 of kas is not the latest anymore.

Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
2022-04-14 10:37:30 +01:00
Andrei Gherzan
9a2c13f822 README.md: Don't advertise meta-oe dependency
The dependencies to the meta-openembedded layers are handled through
dynamic layers so there is no need to advertise this in the
documentation. Especially that the layer configuration doesn't set that
either.

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
2022-02-19 09:27:59 +00:00
Andrei Gherzan
b05c2bdf85 README.md: Add contributing section
This also fixes a check in the yocto project compatible script.
https://bugzilla.yoctoproject.org/show_bug.cgi?id=11131

Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
2022-02-19 09:27:59 +00:00
Andrei Gherzan
fed7688925
README.md: Fix the matrix chat link
matrix.org doesn't allow guest logins which is required by the shield.
Use a custom one to avoid a confusing badge warning.

Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
2021-11-14 02:14:11 +00:00
Andrei Gherzan
da03175b91
Update references to Yocto mailing list
The mailing list infrastructure at Yocto project changed (for a good
while now) but we still reference the old address/links. Update them
accordingly.

Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
2021-11-14 01:13:35 +00:00
Andrei Gherzan
0737be26d2
README.md: Fix sponsor table take two
Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
2021-11-14 00:27:03 +00:00
Andrei Gherzan
705faf1a74
README.md: Fix sponsor table
Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
2021-11-14 00:25:17 +00:00
Andrei Gherzan
0892e309d3
README.md: Fix docs and minor tweaks
* Remove CI badges - I plan to move to github CI soon and they are broken
* anyway. So I might as well look into them when I migrate the CI.
* Update maintainer email.
* Drop temporary the sponsor logo - it breaks documentation builds in
  Read The Docs. I'll check it out when I revamp the docs.
* Update the matrix channel.

Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
2021-11-14 00:19:25 +00:00
Andrei Gherzan
3fe1f79ea2 README.md: Mention build server sponsor
balena.io has been sponsoring the project with a build server for a
while now. It's only fair for us to mention this somewhere in our
README.

Signed-off-by: Andrei Gherzan <andrei@gherzan.ro>
2020-12-18 22:44:13 +00:00
Khem Raj
a34a6d9eaf README: Mention Yoe distro in supported distro list
Remove angstrom as it is no longer uptodate

Fixes Issue #563

Signed-off-by: Khem Raj <raj.khem@gmail.com>
2020-09-03 14:43:34 +01:00
Brandon Verkamp
4982da8d48 docs: Remove reference to xz-compressed sdimg 2020-05-22 15:42:12 +01:00
Brandon Verkamp
a50651ef74 docs: Correct Quick Start instructions to show the new .wic.bz2 extension
Corrects README.md to indicate that the new generated image extension is
.wic.bz2 rather than sdimg as previously stated.

Signed-off-by: Brandon Verkamp <jadelclemens@gmail.com>
2020-05-22 15:42:12 +01:00
Pierre-Jean Texier
4d5c6edc2c README.md: add status badge for raspberrypi4
Signed-off-by: Pierre-Jean Texier <pjtexier@koncepto.io>
2020-03-30 11:52:34 +01:00
Pierre-Jean Texier
d058d2a2cf kas-poky-rpi: add kas file
The kas tool provides an easy mechanism to setup bitbake based projects.

As explained in [1] the key features provided by kas are:

- clone and checkout bitbake layers
- create default bitbake settings (machine, arch, ...)
- launch minimal build environment, reducing risk of host contamination
- initiate bitbake build process

So, let's create a minimal example in this layer to build an image with a
small effort. This seems interesting for new users of the meta-raspberrypi.

For example:

$: sudo pip3 install kas
$: mkdir rpi
$: cd rpi
$: git clone https://github.com/agherzan/meta-raspberrypi.git
$: kas build meta-raspberrypi/kas-poky-rpi.yml

and that's all !

To adjust the construction with specific options (I2C, SPI, ...), simply add
a section as follows:

local_conf_header:
  rpi-specific: |
    ENABLE_I2C = "1"
    RPI_EXTRA_CONFIG = "dtoverlay=pi3-disable-bt"

To configure the machine, the user have to update the 'machine' variable.
And the same for the 'distro'.

[1] - https://kas.readthedocs.io/en/1.0/userguide.html

Signed-off-by: Pierre-Jean Texier <pjtexier@koncepto.io>
2020-01-22 18:09:10 +00:00
Paul Barker
05c86e3160 README: Add documentation badge
Signed-off-by: Paul Barker <pbarker@konsulko.com>
2020-01-20 15:30:24 +00:00
Andrei Gherzan
6c175288cc README.md: Use matrix chat room
Signed-off-by: Andrei Gherzan <andrei@gherzan.ro>
2019-07-25 14:07:24 +01:00
Paul Barker
63e53f9190 docs: Remove reference to deprecated images
Signed-off-by: Paul Barker <pbarker@toganlabs.com>
2018-03-23 20:41:12 +00:00
Paul Barker
8124f87175 readme: Update quick links
* As we now use GitHub for development we should point users at this repo.

* Layer documentation is now published on Read the Docs.

Signed-off-by: Paul Barker <pbarker@toganlabs.com>
2017-12-18 19:20:43 +00:00
Paul Barker
371f85ce53 docs: Format all links correctly
Signed-off-by: Paul Barker <pbarker@toganlabs.com>
2017-05-26 12:16:52 +01:00
Paul Barker
03976f7ff1 docs: Initial split of README into docs directory
The top-level README document has got pretty unwieldy and so we need to
switch to add some more structure to our documentation. The first step
is to split out sub-sections of the README document into separate files
in a new 'docs' directory.

Whilst splitting up the README, we can also take the opportunity to tidy
things up and fix a couple of typos.

Signed-off-by: Paul Barker <pbarker@toganlabs.com>
2017-05-26 12:16:52 +01:00
Andrei Gherzan
abeddc3b0d
README.md: Add info about github pull requests
Signed-off-by: Andrei Gherzan <andrei@gherzan.ro>
2017-05-12 18:38:54 +01:00
Andrei Gherzan
d8da77b57e
README: Migrate to markdown version
Add badges too.

Signed-off-by: Andrei Gherzan <andrei@gherzan.ro>
2017-05-12 18:16:57 +01:00