You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+8-10
Original file line number
Diff line number
Diff line change
@@ -20,10 +20,9 @@ If you need assistance, see the [Help Center](https://support.arduino.cc/hc/en-u
20
20
21
21
## Bugs & Issues
22
22
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.
24
24
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.
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:
39
38
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
41
42
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.
44
44
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.
0 commit comments