1Mojo Public API
2===============
3
4The Mojo Public API is a binary stable API to the Mojo system.
5
6It consists of support for a number of programming languages (with a directory
7for each support language), some "build" tools and build-time requirements, and
8interface definitions for Mojo services (specified using an IDL).
9
10Note that there are various subdirectories named tests/. These contain tests of
11the code in the enclosing directory, and are not meant for use by Mojo
12applications.
13
14C/CPP/JS
15--------
16
17The c/, cpp/, js/ subdirectories define the API for C, C++, and JavaScript,
18respectively.
19
20The basic principle for these directories is that they consist of the source
21files that one needs at build/deployment/run time (as appropriate for the
22language), organized in a natural way for the particular language.
23
24Interfaces
25----------
26
27The interfaces/ subdirectory contains Mojo IDL (a.k.a. .mojom) descriptions of
28standard Mojo services.
29
30Platform
31--------
32
33The platform/ subdirectory contains any build-time requirements (e.g., static
34libraries) that may be needed to produce a Mojo application for certain
35platforms, such as a native shared library or as a NaCl binary.
36
37Tools
38-----
39
40The tools/ subdirectory contains tools that are useful/necessary at
41build/deployment time. These tools may be needed (as a practical necessity) to
42use the API in any given language, e.g., to generate bindings from Mojo IDL
43files.
44