diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c967ef8b..e340e1127 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -## Contributing +# Contributing -### Developing +## Developing -#### Development environment +### Development environment Developing evcc requires [Go][1] and [Node][2]. We recommend VSCode with the [Go](https://marketplace.visualstudio.com/items?itemName=golang.Go), [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and [Vetur](https://marketplace.visualstudio.com/items?itemName=octref.vetur) extensions. @@ -15,7 +15,7 @@ make lint make lint-ui ``` -#### Device templates +### Device templates The software supports a massive amount of different devices (charger, meter, vehicle, tariff) that are defined by **templates**. A template can use the [plugin system](https://docs.evcc.io/docs/devices/plugins) (preferred) for communication with the device or reference a dedicated Go implementation. @@ -38,7 +38,7 @@ make docs This will write the documentation-relevant data to `/templates/docs`. -### Building from source +## Building from source Install prerequisites (once): @@ -60,7 +60,7 @@ To run without creating the `evcc` binary use: go run ./... -#### Cross Compiling +### Cross Compiling To compile a version for an ARM device like a Raspberry Pi set GO command variables as needed, eg: @@ -68,15 +68,15 @@ To compile a version for an ARM device like a Raspberry Pi set GO command variab GOOS=linux GOARCH=arm GOARM=6 make ``` -#### Publishing docker images +### Publishing docker images ```sh make docker DOCKER_IMAGE=my/docker DOCKER_TAG=0815 ``` -### Debugging in VS Code +## Debugging in VS Code -#### evcc Core +### evcc Core To debug a local evcc build in VS Code, add the following entry to your `launch.json`. You can adjust the referred configuration as needed to e.g. use your live configuration. @@ -93,7 +93,7 @@ You can adjust the referred configuration as needed to e.g. use your live config }, ``` -#### UI +### UI For frontend development start the Vue toolchain in dev-mode. Open http://127.0.0.1:7071/ to get to the live reloading development server. It pulls its data from port 7070 (see above). @@ -102,7 +102,7 @@ npm install npm run dev ``` -#### Storybook +### Storybook We're using storybook to develop and visualize UI components in different states. Running the command below will open your browser at http://127.0.0.1:6006/. @@ -110,7 +110,7 @@ We're using storybook to develop and visualize UI components in different states npm run storybook ``` -#### Integration testing +### Integration testing We use Playwright for end-to-end integration tests. They start a local evcc instance with different configuration yamls and prefilled databases. To run them, you have to do a local build first. @@ -119,7 +119,7 @@ make ui build npm run playwright ``` -#### Simulating device state +### Simulating device state Since we don't want to run tests against real devices or cloud services, we've build a simple simulator that lets you emulated meters, vehicles and loadpoints. The simulators web interface runs on http://localhost:7072. @@ -134,7 +134,7 @@ make ui build ./evcc --config tests/simulator.evcc.yaml ``` -### Adding or modifying translations +## Adding or modifying translations evcc already includes many translations for the UI. We're using [Weblate](https://hosted.weblate.org/projects/evcc/evcc/) to maintain translations. Feel free to add more languages or verify and edit existing translations. Weblate will automatically push all modifications to the evcc repository where they get reviewed and merged. @@ -149,3 +149,13 @@ Note: To ensure the build succeeds after creating new translations, make sure to [1]: https://go.dev [2]: https://nodejs.org/ + +## Documentation, Website and iOS/Android App + +We're always thankful for contributions. +Docs, website and app have dedicated repositories. +Please open a GitHub pull request in the respective repository. + +- Documentation: [evcc-io/docs](https://github.com/evcc-io/docs) +- Website: [evcc-io/evcc.io](https://github.com/evcc-io/evcc.io) +- iOS/Android App: [evcc-io/app](https://github.com/evcc-io/app) diff --git a/docs/dip10.jpeg b/docs/dip10.jpeg deleted file mode 100644 index 066277564..000000000 Binary files a/docs/dip10.jpeg and /dev/null differ diff --git a/docs/encoding.md b/docs/encoding.md deleted file mode 100644 index 0b83b0380..000000000 --- a/docs/encoding.md +++ /dev/null @@ -1,9 +0,0 @@ -## API encoding - -| | socket | /api/status | mqtt | push | influx | rest | -| ------------- | -------------------- | ----------------------------- | --------- | ------------- | ------------- | ---- | -| source | chan
encode.New() | cache.State()
encode.New() | chan | cache.All() | chan | - | -| time.Time | rfc3999/nil | rfc3999/nil | rfc3999 | time.Time | time.Time | ? | -| time.Duration | s | s | s | time.Duration | time.Duration | s | -| fmt.Stringer | string | string | string | string | string | ? | -| struct{} | ? | recursive | recursive | n/a | ? | ? | diff --git a/docs/logo.png b/docs/logo.png deleted file mode 100644 index 55c2918d7..000000000 Binary files a/docs/logo.png and /dev/null differ diff --git a/docs/logo.svg b/docs/logo.svg deleted file mode 100644 index 95813b02e..000000000 --- a/docs/logo.svg +++ /dev/null @@ -1 +0,0 @@ -Logo_network_side \ No newline at end of file diff --git a/docs/releng.md b/docs/releng.md deleted file mode 100644 index ac782c36c..000000000 --- a/docs/releng.md +++ /dev/null @@ -1,15 +0,0 @@ -# Branching concept - -- `master` is the default branch -- releases `SHOULD` be triggered from `master` branch -- release will trigger when tag is pushed on any branch -- to create bugfix release, branch from `master` and create a tag -- releases `SHOULD` not be created locally as they will conflict with pushing tagged branch - -## Contents - -Release contains: - -- Github -- Docker -- Cloudsmith diff --git a/docs/screenshot.webp b/docs/screenshot.webp deleted file mode 100644 index 2960edd26..000000000 Binary files a/docs/screenshot.webp and /dev/null differ diff --git a/docs/status.md b/docs/status.md deleted file mode 100644 index 3d4250d32..000000000 --- a/docs/status.md +++ /dev/null @@ -1,8 +0,0 @@ -# Charger status transition events - -From-To|A|B|C --|-|-|- -None
(Startup)|disconnected|connected|connected
start charging -A|-|connected|connected
start charging -B|disconnected|-|start charging -C|disconnected
stop charging|stop charging|-