Skip to content

create AGENTS.md?Β #14383

@m1ga

Description

@m1ga

I have searched and made sure there are no existing issues for the issue I am filing

  • I have searched the existing issues

Description

Should we create a AGENTS.md for the repo?

https://agents.md/#examples has a basic example.

What should we add to make it more AI friendly?

# Titanium SDK
Titanium SDK provides a mature platform for developers to build completely native cross-platform mobile applications using JavaScript. Currently supported native platforms are iOS and Android.

## Folder Structure
- `android/`: Android part of the SDK
- `iphone/`: iPhone/iOS part of the SDK
- `tests/`: Mocha tests
- `apidoc/`: Documentation files

## Testing instructions
- Run `npm i` to install all packages
- Run `npm run cleanbuild` to build a full Titanium SDK and clean it before hand
- Run `npm run build:local` if you don't want to clean the repo before and skip the ZIP file at the end. This will be slightly faster for incremental build runs
- Run `npm run test` to build an SDK and run the included mocha tests
- If you want to build and test only one platform you can use `npm run test:android` or `npm run test:ios`

## PR instructions
- Title format: `chore|docs|feat|fix(android|ios|all): <title>`

What else?

Solution

add a file

Alternatives

No response

Platforms

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureneeds triageThis issue hasn't been reviewed by maintainers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions