Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #67

Open
Fabi755 opened this issue Jun 20, 2023 · 1 comment
Open

Documentation #67

Fabi755 opened this issue Jun 20, 2023 · 1 comment

Comments

@Fabi755
Copy link
Collaborator

Fabi755 commented Jun 20, 2023

I have tried to enable the route snapping. The missing documentation/example lead me to a wrong configuration. I only set the option snapToRoute(true). But I missed to set useDefaultLocationEngine(false) and call forceLocationUpdate(Location).

I want to add a new sample to the example app and also create some documentation.

Now my questions: Do you have a preferred place for write down this things? Some options are

  • Github Wiki
  • README
  • Markdown files in repo

Or don't you want a documentation area? Then I implement the example case and add some comment block above.

@boldtrn
Copy link
Collaborator

boldtrn commented Jun 22, 2023

I think having more documentation would be great. I think md files in the repo would work best? I would be open to alternatives though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants