Embeddinator-4000/objcgen/README.md

# ObjC generator

## Build

Simply run `make` in `Embeddinator-4000/objcgen`.

## Run

Don't use `MonoEmbeddinator4000.exe`.

Use `mono ./bin/Debug/objcgen.exe --gen=Obj-C -o ./Output ManagedAssembly1.dll`.

## Generated API of questionable usability

Whenever we generate a working API that is not optimal (in ObjC) we should update the `docs/BestPracticesObjC.md` document to explain the situation and provide guidance to get the best ObjC API output.

## Missing .NET features

Unimplemented, but planned, features should throw a `NotImplementedException` with the feature name. The generator will report it as a missing feature that does not require a bug report (and test case).

## Unsupported .NET features

Anything that **cannot** be supported should be added to the `docs/Limitations.md` document.

The tool should issue warnings (which users can turn into errors) when it cannot generate ObjC to match any given .NET code. The warnings **must** be added to the `docs/errors.md` document.
[docs] Start a limitations document and add read me for the new directories created in the objc branch (#45) 2017-04-02 21:25:42 +03:00			`# ObjC generator`

[objc][README] Recommend usage of objcgen.exe instead of MonoEmbeddinator4000.exe (#92) objcgen.exe has to be used in order to try the new generator (with the latest fixes). 2017-04-11 09:33:38 +03:00			`## Build`

			Simply run `make` in `Embeddinator-4000/objcgen`.

			`## Run`

			Don't use `MonoEmbeddinator4000.exe`.

			Use `mono ./bin/Debug/objcgen.exe --gen=Obj-C -o ./Output ManagedAssembly1.dll`.

[docs] Start a limitations document and add read me for the new directories created in the objc branch (#45) 2017-04-02 21:25:42 +03:00			`## Generated API of questionable usability`

			Whenever we generate a working API that is not optimal (in ObjC) we should update the `docs/BestPracticesObjC.md` document to explain the situation and provide guidance to get the best ObjC API output.

			`## Missing .NET features`

			Unimplemented, but planned, features should throw a `NotImplementedException` with the feature name. The generator will report it as a missing feature that does not require a bug report (and test case).

			`## Unsupported .NET features`

			Anything that cannot be supported should be added to the `docs/Limitations.md` document.

			The tool should issue warnings (which users can turn into errors) when it cannot generate ObjC to match any given .NET code. The warnings must be added to the `docs/errors.md` document.