canonical / snapcraft

Package, distribute, and update any app for Linux and IoT.
https://snapcraft.io
GNU General Public License v3.0
1.18k stars 446 forks source link

Docs: Harmonize README with template #4957

Open medubelko opened 3 months ago

medubelko commented 3 months ago

What needs to get done

The README is incomplete, and we should be harmonizing all of them across craft projects.

For now, we can rewrite it using the template in https://github.com/canonical/starbase/issues/233, and leave the build section blank while @sergiusens polishes it.

Depends on https://github.com/canonical/starbase/issues/233.

Why it needs to get done

Improves contributor documentation.

syncronize-issues-to-jira[bot] commented 3 months ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3196.

This message was autogenerated