From 87f22559d047e677f268ad1844f88a811df41baf Mon Sep 17 00:00:00 2001 From: InstantMuffin Date: Wed, 3 Aug 2022 14:47:33 +0200 Subject: [PATCH 1/2] Update BUILDING.md Added "Notes for Linux contributors" based on my own building experience --- BUILDING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index ed13b2e93..6f5cec682 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -89,6 +89,18 @@ This project is built on [GitHub Actions](https://github.com/arduino/arduino-ide git push origin 1.2.3 ``` +## Notes for Linux contributors +These are based on a XUbuntu 22.04 LTS system. +You will need the following dependencies: + + - Nodejs-14.0 or up + - Dependencies for node-native-keymap: + +```sudo apt-get install -y g++ gcc make python2.7 pkg-config libx11-dev libxkbfile-dev libsecret-1-dev``` + +Source: https://stackoverflow.com/a/55878577 + +Yarn will then download additional dependencies automatically and start the build process. The initial setup and build with yarn takes less than 5 minutes on an AMD Athlon 200GE. ## Notes for macOS contributors Beginning in macOS 10.14.5, the software [must be notarized to run](https://developer.apple.com/documentation/xcode/notarizing_macos_software_before_distribution). The signing and notarization processes for the Arduino IDE are managed by our Continuous Integration (CI) workflows, implemented with GitHub Actions. On every push and pull request, the Arduino IDE is built and saved to a workflow artifact. These artifacts can be used by contributors and beta testers who don't want to set up a build system locally. From e3cb6b8b62eb26350f9c0ad6086471f625881b15 Mon Sep 17 00:00:00 2001 From: InstantMuffin Date: Wed, 3 Aug 2022 16:26:22 +0200 Subject: [PATCH 2/2] Update BUILDING.md Removing the linux specific section and instead updating the Theia IDE prerequisites link to point to the mentioned file directly. --- BUILDING.md | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 6f5cec682..15499bfdd 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -41,7 +41,7 @@ The _frontend_ is running as an Electron renderer process and can invoke service If you’re familiar with TypeScript, the [Theia IDE](https://theia-ide.org/), and if you want to contribute to the project, you should be able to build the Arduino IDE locally. -Please refer to the [Theia IDE prerequisites](https://github.com/theia-ide/theia/blob/master/doc/) documentation for the setup instructions. +Please refer to the [Theia IDE prerequisites](https://github.com/eclipse-theia/theia/blob/master/doc/Developing.md#prerequisites) documentation for the setup instructions. > **Note**: Node.js 14 must be used instead of the version 12 recommended at the link above. Once you have all the tools installed, you can build the editor following these steps @@ -89,19 +89,6 @@ This project is built on [GitHub Actions](https://github.com/arduino/arduino-ide git push origin 1.2.3 ``` -## Notes for Linux contributors -These are based on a XUbuntu 22.04 LTS system. -You will need the following dependencies: - - - Nodejs-14.0 or up - - Dependencies for node-native-keymap: - -```sudo apt-get install -y g++ gcc make python2.7 pkg-config libx11-dev libxkbfile-dev libsecret-1-dev``` - -Source: https://stackoverflow.com/a/55878577 - -Yarn will then download additional dependencies automatically and start the build process. The initial setup and build with yarn takes less than 5 minutes on an AMD Athlon 200GE. - ## Notes for macOS contributors Beginning in macOS 10.14.5, the software [must be notarized to run](https://developer.apple.com/documentation/xcode/notarizing_macos_software_before_distribution). The signing and notarization processes for the Arduino IDE are managed by our Continuous Integration (CI) workflows, implemented with GitHub Actions. On every push and pull request, the Arduino IDE is built and saved to a workflow artifact. These artifacts can be used by contributors and beta testers who don't want to set up a build system locally. For security reasons, signing and notarization are disabled for workflow runs for pull requests from forks of this repository. This means that macOS will block you from running those artifacts.