golioth / docs

Creative Commons Attribution Share Alike 4.0 International
6 stars 10 forks source link

Should "Creating a New Application from Scratch" use zephyrproject-rtos/example-application? #26

Open beriberikix opened 3 years ago

beriberikix commented 3 years ago

https://docs.golioth.io/docs/guides/creating-an-app/ https://github.com/zephyrproject-rtos/example-application

The "Creating a New Application from Scratch" guide describes how to build a Zephyr project out of tree. The Zephyr folks have been developing a similar example repo that covers best practices. Moreover, they recently turned on the "repo template" feature.

So should we:

  1. Move to using example-application?
  2. Instruct users to create a new repo from the template?

Looking for input!

lachlansneff commented 3 years ago

I'd suggest we move over to using the template/example-application. It's a shame that the example still pulls down basically every zephyr library including the kitchen sink (they really need to work on that IMO) though.

We can tell people to use the zephyr docs and then tell them to add golioth to the west.yml at the end.

beriberikix commented 3 years ago

We can also tell people to restrict the projects they import. Did we ever figure out how to do that in the west.yaml?

lachlansneff commented 3 years ago

I couldn't figure it out, but I didn't try too hard tbh, maybe @mniestroj figured it out?

beriberikix commented 3 years ago

https://github.com/zephyrproject-rtos/zephyr/issues/36324 relevant?

0Grit commented 2 years ago

https://github.com/golioth/app-hello-golioth is derived from https://github.com/zephyrproject-rtos/example-application.

It will not be this sprint but I want to change our starting from scratch guide to use app-hello-golioth as an example.