search

tangrams / tangram-es

2D and 3D map renderer using OpenGL ES
MIT License
821 stars 238 forks source link

iOS documentation out date for versions after 0.9.6 #1941

Open brianLeeson opened 5 years ago

brianLeeson commented 5 years ago

NOTE: This is only an issue if one is using master. 0.9.6 is fine!

TO REPRODUCE THE ISSUE, FOLLOW THESE STEPS: Looked for iOS getting started documentation

RESULT: Outdated documentation

EXPECTED RESULT: I am hoping to find a "getting started" for tangram with iOS

ENVIRONMENT: Developing on MacOS for iOS

OTHER: After the 0.9.6 release there were some changes. This change of the TGMapViewController into TGMapView does not mesh with how the current documentation says to use TangramMaps. "2. Create a basic ViewController that inherits from TGMapViewController." This isn't possible as TGMapViewController doesn't exist anymore. Does a "getting started" equivalent exist for the newest code base?

@matteblair, you made these changes to the code. Do you have the answers for which I seek?

tallytalwar commented 5 years ago

Ohh we should update the documentation to reflect the new usage of TGMapView as a UIView. Which is now the recommended way of using the iOS interface.

matteblair commented 5 years ago

Ah yep - good catch! The good news is that the "getting started" guide should be simpler now with TGMapView. I'll revise this when I get a chance.

brianLeeson commented 5 years ago

Quick response! Looking forward to reading the new docs. Thank you. Will this new method of using Tangram require a rework of the tangram demo? Or would you say that it is currently representative of how Tangram should be used?

matteblair commented 5 years ago

The demo application in the repo is a reasonable example of code structure for using Tangram. However the build configuration is not typical because we've integrated it with the Tangram framework. Ideally we'd have an application sample that retrieves the framework from CocoaPods.