Sharing a Project#

If you need to share a project and the recipient cannot check it out from source control, use one of the following methods. Before you begin, exit Simplicity Studio and VS Code.

Method A: Create an Archive from Git#

Use this method if your project is under Git source control and includes a .gitignore file similar to the recommended Gitignore example.

  1. Open a command prompt in the project directory.

  2. Run one of the following commands:

    git archive -o project.zip HEAD

    or

    git archive -o project.tar HEAD

These commands create a shareable archive that excludes files with user-specific paths and other files the recipient would otherwise need to remove.

Method B: Remove Unnecessary Folders and Files#

If you do not use Git, or prefer to create the archive manually, remove the following folders from the project:

  • .git (or other source control folders)

  • .projectlinkstore

  • cmake_gcc/build/

  • *.cmake

  • .vscode/

  • artifact/

  • trashed_modified_files/

You do not need to remove the following folders, but they are recreated during project generation and can be safely deleted:

  • autogen/

  • simplicity_sdk*/

If you need to include the output binary files, do not remove these folders:

  • cmake_gcc/build/base

  • artifact/

After you remove the appropriate folders, create a .zip file of the project folder and share it with the recipient.