Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Filename / Directory

Description / Purpose

LICENSE

The module's full license text; this will be distributed with the module to let other developers know how they can use and redistribute it.

README

The file that gives a short explanation of the module project. This file is not distributed with your module.

assets

The directory where you should place module assets, such as images.

documentation

The directory where you should place your module documentation for end-users. The file index.md is a Markdown-formatted template file that you should use when writing your module documentation. You may also write your documentation using the TDoc Specification. This is only required for module distributed in the Appcelerator Marketplace. You can safely ignore this directory if you do not intend to distribute your module.

example

The directory where your module example(s) should go. The file app.js will be generated to include a sample loading of your module in a test window. This file can be used for quickly testing your module as well as give an example to end-users on how to use your module. This directory is distributed with your module.

windows/include

The directory where your C++/CX header classes should go, used by the Visual Studio compiler. By default, when you create a new project, you are given a boiler plate module class (ModuleId.hpp). These files are not distributed with your module. For information about these files, see Windows Module Architecture.

windows/src

The directory where your C++/CX implementation classes should go, used by the Visual Studio compiler. By default, when you create a new project, you are given a boiler plate module class (ModuleId.cpp). These files are not distributed with your module. For information about these files, see Windows Module Architecture.

windows/cmakeThe directory which contains configuration files used by cmake. These files are not distributed with your module.
windows/CMakeLists.txt

A special file that describes configuration used about your module used by cmake. These files are not distributed with your module.

windows/manifest

A special file that describes metadata about your module and used by the Titanium compiler. This file is required and is distributed with your module. 

windows/WindowsPhoneWindows10.ARM

The directory which contains your Windows Phone 10 project for ARM. Open this directory to launch your module project in Visual Studio. This directory is not distributed with your module.

windows/WindowsPhoneWindows10.Win32

The directory which contains your Windows Phone 10 project for Win32. Open this directory to launch your module project in Visual Studio. This directory is not distributed with your module.

windows/WindowsStore.Win32The directory which contains your Windows Store project for Win32. Open this directory to launch your module project in Visual Studio. This directory is not distributed with your moduleplatform

Files in this folder are copied directory into the Windows build directory (<project-dir>/build/windows) when the Windows app is compiled. For example you can place res strings under windows/platform/Strings folder, and place drawable files under windows/platform/Assets folder. Files in this directory are copied directly on top of whatever files are already in the build directory, so please be careful that your files don't clobber essential project files or files from other modules.

windows/timodule.xml

Titanium module configuration file. The format is described in tiapp.xml and timodule.xml Reference. This file is not currently supported by Windows modules.

...