search

frequenz-floss / frequenz-api-weather

gRPC+protobuf specification and Python bindings for the Frequenz Weather API
MIT License
1 stars 8 forks source link

Document the setup process #97

Closed david-natingga-frequenz closed 7 months ago

david-natingga-frequenz commented 7 months ago

What's needed?

Document the whole process from getting the repository, building it, installing it, up to the state when we can run the example on getting the historical data.

Proposed solution

No response

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

david-natingga-frequenz commented 7 months ago

This is not needed as I found all the instructions in https://github.com/frequenz-floss/frequenz-api-weather/blob/v0.x.x/CONTRIBUTING.md. It is just not very intuitive that the setup instructions would be placed in that file. There is need to set this up even if one does not need to contribute. Perhaps, we could rethink the name or divide the documentation into SETUP.md and CONTRIBUTING.md.