evcc icon indicating copy to clipboard operation
evcc copied to clipboard

chore: add debug examples to main Readme

Open GrimmiMeloni opened this issue 1 year ago • 2 comments

Just adding two example configurations for VS Code's debugger to the "Contribute" section of the Readme.

GrimmiMeloni avatar Mar 23 '24 11:03 GrimmiMeloni

@GrimmiMeloni @naltatis das ist super spezifisch. Was haltet ihr davon, das komplette Thema in die Doku zu verfrachten und aus der README nur drauf zu verlinken?

andig avatar Mar 23 '24 14:03 andig

Das wäre auch OK. Mir ist nur wichtig es zu dokumentieren. Wo genau ist aus meiner Sicht eher Nebensache.

GrimmiMeloni avatar Mar 23 '24 16:03 GrimmiMeloni

Ich würd das nicht in der Doku sehen. Das ist ja ein reines Entwicklerthema und damit mMn. total gut in der Readme angesiedelt. Würde ungern in der Anwenderdoku nen neuen Top-Level "Entwickler" Punkt aufmachen.

naltatis avatar Mar 24 '24 09:03 naltatis

Fair point. Wir wäre es das in ein eigenes CONTRIBUTING.md auszulagern?

andig avatar Mar 24 '24 10:03 andig

Wir wäre es das in ein eigenes CONTRIBUTING.md auszulagern?

Find ich ne gute Idee. Dann könnte man da auch Code-Style, Testing, ... weiter ausführen und erklären als wir das heute tun.

naltatis avatar Mar 24 '24 10:03 naltatis

Da würde sich auch gleich noch ein "howto publish docker" mit anbieten:

make docker DOCKER_IMAGE=my/docker DOCKER_TAG=0815

andig avatar Mar 24 '24 11:03 andig

Der bot hat mich gerade hieran erinnert. Ist untergegangen.

@naltatis ich kenne mich mit dem docs project nicht gut aus. Was muß ich tun um ein neues Markdown file für das Thema Contributions in die Strukturen mit einzuhängen? Ich habe mit dem Thema .mdx wenig/keine Erfahrung.

GrimmiMeloni avatar Apr 20 '24 07:04 GrimmiMeloni

Ich glaube die Idee war einfach eine neue Datei hier im Repo anzulegen, nicht unter Doku.

andig avatar Apr 20 '24 08:04 andig