An open API service indexing awesome lists of open source software.

https://github.com/rdkcentral/meta-rdk-broadband-apps

Meta layer to add the Broadband Apps Framework to your existing RDK image.
https://github.com/rdkcentral/meta-rdk-broadband-apps

Last synced: 6 months ago
JSON representation

Meta layer to add the Broadband Apps Framework to your existing RDK image.

Awesome Lists containing this project

README

          

# meta-rdk-broadband-apps
Meta layer to add the Broadband Apps Framework to your existing RDK image.

[![Deploy MkDocs to GitHub Pages](https://github.com/rdkcentral/meta-rdk-broadband-apps/actions/workflows/deploy_docs.yml/badge.svg)](https://github.com/rdkcentral/meta-rdk-broadband-apps/actions/workflows/deploy_docs.yml)

[![GitHub milestone details](https://img.shields.io/github/milestones/progress-percent/rdkcentral/meta-rdk-broadband-apps/2)](https://github.com/rdkcentral/meta-rdk-broadband-apps/milestone/2)

[![GitHub milestone details](https://img.shields.io/github/milestones/progress-percent/rdkcentral/meta-rdk-broadband-apps/1)](https://github.com/rdkcentral/meta-rdk-broadband-apps/milestone/1)

## Getting Started & Technical Docs:
See the `docs/` folder, or visit the live [GitHub Pages site](https://rdkcentral.github.io/meta-rdk-broadband-apps/).

### Building the GitHub Pages Site
We use `mkdocs` to publish `.md` files in the `docs/` folder to GitHub Pages.

See [Docs Generation Workflow](.github/workflows/deploy_docs.yml).

Required setting for this to work:
> * __Settings > Pages__
> * Under __"Build and deployment"__:
> * __Select Source:__ `GitHub Actions`

### Preview The Site On Your Local Machine
To preview the Pages site on your local machine:
```bash
pip install -r docs/requirements.txt
mkdocs serve
```
This will run a local server at http://127.0.0.1:8000/.