Version 0.0.2: Update Readme.md - Githubissues

it-at-m / epitaph_ips

Library for Indoor Positioning purposes

https://pub.dev/packages/epitaph_ips

MIT License

35 stars 8 forks source link

Version 0.0.2: Update Readme.md #3

Open ToluAta opened 2 years ago

ToluAta commented 2 years ago

Our Readme is not completed yet and needs updates. Problems:

Logo is broken at https://pub.dev/packages/epitaph_ips. If it cannot be shown it should be taken out of Readme.md
Report Bug and Request Feature links are not proper and only link to the main page. They should link to the relevant action.
Installation section should be deleted completely. This section explains it good enough
Usage should be finalized
Documentation should link to https://pub.dev/documentation/epitaph_ips/latest/

michaelessiet commented 2 years ago

Do you want the Installation section taken out completely ? Or do you want it to have detailed installation instructions

ToluAta commented 2 years ago

Hi I updated the issue to hopefully be more precise. The Installation section should be taken out completely. Usage will be finalized by @cwjwisse

Tomiiwa commented 2 years ago

Hi, I want to work on this

Tomiiwa commented 2 years ago

For No. 2, where should they lead to? For No. 4, what do you mean by finalized?

21satvik commented 2 years ago

Hello Can I help with this?

ToluAta commented 2 years ago

I looked at both the PRs and would continue with the one from @21satvik . Report Bug should link to: https://github.com/it-at-m/epitaph_ips/issues/new?assignees=&labels=&template=bug_report.md&title= Request Feature should link to: https://github.com/it-at-m/epitaph_ips/issues/new?assignees=&labels=&template=feature_request.md&title=

21satvik commented 2 years ago

Added both