OLD | NEW |
| (Empty) |
1 Welcome to the Native Client SDK project_templates directory. | |
2 | |
3 Currently, this directory contains a mechanism to allow a developer to | |
4 bootstrap a native client project and write a lot of the NaCl-specific code | |
5 automatically, so the developer can add her own functionality quickly. The | |
6 projects created are designed to be self-contained, meaning that they have | |
7 everything they need to run, except a server. | |
8 | |
9 To start a project, run "./init_project.py" or "python init_project.py" | |
10 depending on your system configuration. The script will give you usage | |
11 information when run with -h or when insufficient or malformed arguments are | |
12 provided. | |
13 | |
14 The result of the script is a project with the name you provide at a location | |
15 of your choice. If you have your own server, you may create the project in | |
16 a location it serves. Otherwise, you may create a project under the SDK | |
17 examples directory and examples/httpd.py to serve your project quickly - at | |
18 least temporarily. | |
19 | |
20 In the future, this directory is intended as a repository for useful stub code, | |
21 code snippets, and code generators that can be used to facilitate rapid | |
22 development. For now we support initial project setup via init_project.py, but | |
23 any generically useful code can be added here if it follows a reasonable | |
24 organization. The organization is as follows: | |
25 | |
26 project_templates: | |
27 Contains any top-level scripting elements that apply or may come in useful | |
28 for the generation of all NaCl/Pepper2 projects, common Makefile sections, | |
29 and this README. | |
30 project_templates/[language]: | |
31 For any given language there should be a directory with a name that is | |
32 commonly associated with that language. | |
33 project_templates/[topic] | |
34 project_templates/[language]/[topic] | |
35 For any given programming topic, such as audio, 2d, or 3d programming, there | |
36 should be a directory at the root level for any components that are not | |
37 language specific and that may apply to that topic. For corresponding | |
38 components that are language specific, a sub-directory for the topic may | |
39 also be created under the language directory. | |
40 | |
41 Note that the layout in this directory does not reflect the layout of the | |
42 projects that are created. It is merely a set of simple guidelines to help | |
43 organize generic code and utilities so they can be managed here. How | |
44 generated projects are laid out is left up to the design of the particular | |
45 code-generator. | |
OLD | NEW |