Install embedXcode

Install the template

The installation of embedXcode is now performed by the Install embedXcode utility, as the PackageMaker utility previsouly used to generate the installation package no longer works on macOS 10.14 Mojave.

Download embedXcode

Download the embedXcode package directly from the download page .

For the systems running Xcode 11 on macOS 10.14 Mojave or 10.15 Catalina,

  • Select the main option.

Safari prompts a warning dialogue box.

  • Click on Allow to proceed with the download.

For legacy systems running Xcode 10 on macOS 10.13 High Sierra or 10.14 Mojave,

  • Please select the embedXcode Legacy 10 option. It corresponds to embedXcode release 10.9.9.

Warning

embedXcode Legacy 10 is no longer developed and has limited support.

This section requires the embedXcode+ edition.

For legacy systems running Xcode 9 on macOS 10.12 Sierra or 10.13 High Sierra,

  • Please select the embedXcode Legacy 9 option. It corresponds to embedXcode release 9.6.8.

Danger

embedXcode Legacy 9 is deprecated and no longer supported.

For a complete list of the macOS and Xcode versions corresponding to the previous releases of embedXcode,

For more information on legacy versions,

Install embedXcode

The downloaded file is either a disk image with extension .dmg or a compressed file with extension .zip.

In case of a disk image with extension .dmg,

  • Double-click on the embedXcode.dmg or embedXcode-Plus.dmg dmg file to unzip the disk image.

Alternatively, for a compressed file with extension .zip,

  • Double-click on the embedXcode.zip or embedXcode-Plus.zip zip file to unzip the file.

  • Open the resulting folder.

Then,

  • Double-click on the Install embedXcode utility to launch the installation.

The installation starts and displays the licence agreement.

  • Click on I Agree to proceed.

  • Otherwise, click on I Decline to end.

The installation checks if embedXcode is already installed. If so, it switches to the update procedure.

If the release already installed is too old, an error message is displayed.

The safest way consists on removing the previous release and proceeding with a fresh installation.

  • Run the Uninstall embedXcode utility as described at section Uninstall the template .

  • Launch the Install embedXcode utility again.

If the release already installed is more recent, a warning message is displayed.

No action is needed.

  • Click on Cancel.

A dialogue box asks for confirmation.

  • Click on OK to launch the installation.

  • Otherwise, click on Cancel to cancel the installation.

Installation starts and doesn't ask for a password as all the files are installed inside the user's home folder.

A Console window provides information about the files being copied.

For the embedXcode+ edition, the embedXcode utilities need to be authorised.

A first dialogue box warns about the next one.

  • Click on OK to continue.

The second dialogue aks for the password to authorise the embedXcode utilities.

  • Enter the username and the password.

  • Click on Modify settings to authorise the embedXcode utilities.

A dialogue box informs the installation is completed.

Additionnaly, the utility opens the Release notes page.

Finally, the utility opens the Check Platforms and MCUs page.

  • Check the platforms and MCUs you plan to use are up to date.

  • Close the different Terminal and Console windows.

Check the installation process

To check the installation process,

  • Launch the Console application,

  • Select ~/Library/Logs on the left pane.

  • Locate the embedXcode Installation.log under the Files section.

Set the folder for standard IDEs

This section requires the embedXcode+ edition.

This is an optional procedure.

By default, the folder where the standard IDEs are installed and located is the /Applications folder.

However, if you've installed all the IDEs on another folder, an option allows to change the folder.

For example, if the IDEs are located on the /Applications/IDE folder,

  • Open the ~/Documents/embedXcode folder.

  • Double click on Define paths to IDEs.

A window asks for the folder containing all the standard IDEs.

  • Select the folder containing the IDEs and click on Choose.

A notification confirms the new path.

Alternatively, on a project basis,

Authorise the utilities

macOS 10.15 Catalina aggressive protection may deny some utilities from running.

The utilities need to access the ~/Documents folder where the projects are and the ~/Library/embedXcode folder where embedXcode is installed.

To allow the utilities,

  • Call the menu  > System Preferences.
  • Select the Security & Privacy section and the Privacy pane.
  • Click on the lock and enter the system password to unlock it.
  • Drag and drop the utility into the list of applications.

Uninstall the template

There is an automatic procedure to uninstall the template.

  • Click on Uninstall embedXcode located on the embedXcode folder:

A dialogue box opens and asks for confirmation:

  • Click on OK to proceed or on Cancel to abort.

As an alternative, the manual procedure requires to delete the following files and folders:

  • Delete the folder embedXcode under ~/Documents.

This folder contains the utilities and the Release Notes for embedXcode.

  • Delete the folder embedXcode under ~/Library.

This folder contains the frameworks, tool-chains, licences, preferences, makefiles and utilities used by embedXcode.

  • Delete all the sub-folders related to embedXcode or embedXcode+ under the folders ~/Library/Developer/Xcode/Templates/Files Templates and ~/Library/Developer/Xcode/Templates/Project Templates.

Those folders contain the templates for the embedXcode files and projects.

  • Keep the sub-folders which are not related to embedXcode or embedXcode+.

  • Delete the files under ~/Library/Developer/Xcode/ UserData/CodeSnippets.

This folder contains the code snippets for embedXcode.

For the IDEs and optional tools you may have installed,

  • Please refer to the respective procedures supplied by their editors