GitHub - yodaos-project/yodaos: AI OS for Web Community

README.md

This is a modern operating system for next generation interactive device, and it embraces Web community, uses JavaScript as the application language.

Get Started

To start with compiling YODAOS, a Linux is required, we recommand the followings distributions:

• Ubuntu 16.04
• Centos 7

For Ubuntu:

$ apt-get install build-essential subversion libncurses5-dev zlib1g-dev gawk gcc-multilib flex git-core gettext libssl-dev unzip texinfo device-tree-compiler dosfstools libusb

For Centos 7, the install command-line is:

$ yum install -y unzip bzip2 dosfstools wget gcc gcc-c++ git ncurses-devel zlib-static openssl-devel svn patch perl-Module-Install.noarch perl-Thread-Queue

And the device-tree-compiler also needs to install manually:

$ wget http://www.rpmfind.net/linux/epel/6/x86_64/Packages/d/dtc-1.4.0-1.el6.x86_64.rpm
$ rpm -i dtc-1.4.0-1.el6.x86_64.rpm

Download Source

Click http://openai-corp.rokid.com, and do register as Rokid Developer.

Then, go SSH Settings to config your local public key.

https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/

Install the repo cli

YODAOS uses the repo command-line to manage the source tree:

Repo unifies Git repositories when necessary, performs uploads to the Gerrit revision control system, and automates parts of the Android development workflow. Repo is not meant to replace Git, only to make it easier to work with Git in the context of Android. The repo command is an executable Python script that you can put anywhere in your path.

Follow the below commands to install manually:

$ curl https://raw.githubusercontent.com/yodaos-project/yodaos/master/tools/repo > /usr/local/bin/repo
$ chmod 777 /usr/local/bin/repo

And use repo --help to test if installation is done.

Compile

When the repo cli is ready, follow the instruments to get the complete source of YODAOS:

$ repo init -u https://github.com/yodaos-project/yodaos.git -m manifest.xml --repo-url=http://openai-corp.rokid.com/tools/repo --no-repo-verify
$ repo sync

The above takes few minutes, just be patient. The next step is to build out the OS image, let's take the example of Raspberry board:

$ cp -r products/yodaos/rbpi-3b-plus/configs/broadcom_bcm2710_rpi3b_plus_defconfig openwrt/.config
$ cd openwrt
$ make defconfig && make

Go compile & run for more details.

Children projects

The YODAOS is a group of children projects open sourced which mainly are:

Framework

• yodart is the application-layer of YODAOS, it's also the VUI framework for JavaScript.

Core

• flora is the PUB/SUB messaging library, also supports the request/response model for IPC.
• ShadowNode is the Node.js runtime that implements most of core APIs and N-API-compatible.

Service

• yoda-flora-dispatcher is the centered service for flora.
• yoda-speech-service is the speech service that talks to Rokid ASR/NLP cloud.

Releases

This section describes how do YODAOS release and its lifecycle.

versions

YODAOS uses Semver 2.0 for versioning management, and we have lifecycles for major and minor.

• major: one release per 6 month, and all releases are stable.
• minor: one release per 1 month, and only the even ones are stable, namely 1.0.x, 1.2.x, 1.4.x.

We assume the 3rd Thursday at every month as YodaOS release date.

release requirements

Every release must contain the following parts:

• Repo manifest commit with specific version, for downloading the source code.
• Multiple platform images, includes:
  • Rokid Kamino18 soc.
  • AmLogic A113.
• Changelog describes what changes this updated.

stable and pre-versions

Stable version requires the complete tests on:

• Compatibility test suite
• Unit tests of modules and services
• Functional tests
• Integration tests

The above workload is in usual 2 weeks for the team, therefore we introduce pre-version, namely release candidates(RC) to track the stable releasing progress.

For stable version, we preserve 2 weeks at least to take the workload of full tests, and create a pre-version branch v1.2.x-rc. Once all the full tests are passed, then create a stable branch(v1.2.x) from release candidate branch(v1.2.x-rc).

Project Team Members

TSC (Technical Steering Committee)

• algebrait - Weigang Xu [email protected]
• lanfly - Xiaofei Lan [email protected]
• legendecas - Chengzhong Wu [email protected]
• mingzc0508 - Cheng Zhang [email protected]
• yorkie - Yorkie Liu [email protected]

Community

• YouTube

Contributing

YODAOS is a community-driven project that we accepts any improved proposals, pull requests and issues.

• For JavaScript development, go yodart for details.
• For proposal, yodaos-project/evolution is the place where someone can submit pull request to propose something.

Documentation

• Yoda Book
• API reference

License

Apeach 2.0