Skip to content

Commit e8b0ea4

Browse files
committed
Reduce overlap between readme and development+contributor guides
The readme should provide a concise overview of the essential information about the project. Additional details are provided in dedicated documents, so the readme only needs to provide links to that information.
1 parent 7c1ca04 commit e8b0ea4

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

Diff for: README.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ If you need assistance, see the [Help Center](https://support.arduino.cc/hc/en-u
2020

2121
## Bugs & Issues
2222

23-
If you want to report an issue, you can submit it to the [issue tracker](https://github.com/arduino/arduino-ide/issues) of this repository. A few rules apply:
23+
If you want to report an issue, you can submit it to the [issue tracker](https://github.com/arduino/arduino-ide/issues) of this repository.
2424

25-
- Before posting, please check if the same problem has been already reported by someone else to avoid duplicates.
26-
- Remember to include as much detail as you can about your hardware set-up, code and steps for reproducing the issue. Make sure you're using an original Arduino board.
25+
See [**the issue report guide**](docs/contributor-guide/issues.md#issue-report-guide) for instructions.
2726

2827
### Security
2928

@@ -35,16 +34,15 @@ e-mail contact: [email protected]
3534

3635
## Contributions and development
3736

38-
Contributions are very welcome! You can browse the list of open issues to see what's needed and then you can submit your code using a Pull Request. Please provide detailed descriptions. We also appreciate any help in testing issues and patches contributed by other users.
37+
Contributions are very welcome! There are several ways to participate in this project, including:
3938

40-
This repository contains the main code, but two more repositories are included during the build process:
39+
- Fixing bugs
40+
- Beta testing
41+
- Translation
4142

42-
- [vscode-arduino-tools](https://github.com/arduino/vscode-arduino-tools): provides support for the language server and the debugger
43-
- [arduino-language-server](https://github.com/arduino/arduino-language-server): provides the language server that parses Arduino code
43+
See [**the contributor guide**](docs/CONTRIBUTING.md#contributor-guide) for more information.
4444

45-
See the [development guide](docs/development.md) for a technical overview of the application and instructions for building the code.
46-
47-
You can help with the translation of the Arduino IDE to your language here: [Arduino IDE on Transifex](https://www.transifex.com/arduino-1/ide2/dashboard/).
45+
See the [**development guide**](docs/development.md) for a technical overview of the application and instructions for building the code.
4846

4947
## Donations
5048

Diff for: docs/development.md

+6
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ The _frontend_ is running as an Electron renderer process and can invoke service
3636
[1]: https://www.electronjs.org/docs/tutorial/application-architecture#differences-between-main-process-and-renderer-process
3737
[2]: https://code.visualstudio.com/Docs/editor/tasks
3838

39+
### Additional Components
40+
41+
This repository contains the main code, but two more repositories are included during the build process:
42+
43+
- [vscode-arduino-tools](https://github.com/arduino/vscode-arduino-tools): provides support for the language server and the debugger
44+
- [arduino-language-server](https://github.com/arduino/arduino-language-server): provides the language server that parses Arduino code
3945

4046
## Build from source
4147

0 commit comments

Comments
 (0)