https://github.com/m-tmatma/yocto-manual

yocto manual
https://github.com/m-tmatma/yocto-manual

Last synced: about 7 hours ago
JSON representation

yocto manual

• Host: GitHub
• URL: https://github.com/m-tmatma/yocto-manual
• Owner: m-tmatma
• Created: 2020-11-07T00:40:17.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-11-03T07:31:46.000Z (about 2 years ago)
• Last Synced: 2023-08-04T08:24:59.886Z (over 1 year ago)
• Language: Shell
• Homepage:
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build status](https://github.com/m-tmatma/yocto-manual/workflows/CI/badge.svg)](https://github.com/m-tmatma/yocto-manual/actions?query=workflow%3ACI)

# yocto-manual

Build yocto reference manual based on the following document.

https://git.yoctoproject.org/cgit.cgi/poky/tree/documentation/README?h=zeus

https://git.yoctoproject.org/cgit.cgi/poky/plain/documentation/README

## How to build yocto manual on docker

1. Run `build-image.sh` which uses `docker` command.

2. Run `pdf.sh` which uses `docker` command.

If your current user is in `docker` group, you can

```

./build-image.sh

./pdf.sh

```

## How to build yocto manual on ubuntu (not docker)

### prepare

```

sudo apt-get update

sudo apt-get install -y git-core \

    make xsltproc fop \

    python3 python3-dev python3-pip python3-setuptools python3-sphinx python3-yaml python3-sphinx-rtd-theme

```

### Get Source code

You can specify branch name by `-b` option. In the following example, `zeus` branch will be checkout initially.

```

git clone -b zeus git://git.yoctoproject.org/poky

```

or

```

git clone -b zeus https://git.yoctoproject.org/git/poky

```

### build

```

cd poky/documentation

make pdf DOC=ref-manual

```

You can get `poky/documentation/ref-manual/ref-manual.pdf`