# Package recipes for Aurora OS

The repository contains the source codes of recipes that are used to create
[Conan](https://conan.io/) packages for usage in developing applications
for Aurora OS.

## Terms of Use and Participation

The source code of the project is provided under 
[the license](LICENSE.BSD-3-Clause.md), which allows its use in third-party 
applications.

The [contributor agreement](CONTRIBUTING.md) documents the rights granted by 
contributors of the Open Mobile Platform.

Information about the contributors is specified in the [AUTHORS](AUTHORS.md) 
file.

[Code of conduct](CODE_OF_CONDUCT.md) is a current set of rules of the 
Open Mobile Platform which informs you how we expect the members of the 
community will interact while contributing and communicating.

## Project Structure

* [docs](docs) directory contains documentation on creating and using packages and documentation on using tools.
  * [build-mfw-package.md](docs/build-mfw-package.md) file contains a short sequence of actions for assembling Mfw QML plugins.
  * [build-package-tool.md](docs/build-package-tool.md) file contains a brief reference on how to use the `build-package` build tool provided with this repository.
  * [build-tensorflow-lite-package.md](docs/build-tensorflow-lite-package.md) file contains a short sequence of actions to build TensorFlow.
  * [create-conan-packages.md](docs/create-conan-packages.md) file contains a description of the recommended way to create Conan packages for use in Aurora OS applications.
  * [publish-packages.md](docs/publish-packages.md) file contains instructions on how to publish packages to the repository.
  * [setup-sdk.md](docs/setup-sdk.md) file contains information about setting up the development environment.
  * [use-conan-packages.md](docs/use-conan-packages.md) file contains information about using conan packages when developing applications for Aurora OS.
* [recepies](recepies) directory contains directories with recipes. A separate catalog is allocated for each recipe.
* [tools](tools) directory contains tools that make it easier to develop and publish packages.

## Compatibility

The project is compatible with all the supported versions of the Aurora OS.

## This document in Russian / Перевод этого документа на русский язык

- [README.ru.md](README.ru.md)
