Skip to content

Commit

Permalink
added comments
Browse files Browse the repository at this point in the history
  • Loading branch information
3a4oT committed Mar 5, 2021
1 parent 2ccb7c2 commit 640d1be
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions scripts/generate_spm_sources_layout.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
#!/bin/sh

# Swift Package Manager [has some strict requirements](https://github.com/apple/swift-package-manager/blob/main/Documentation/Usage.md#creating-c-language-targets) to source files layout.
# We can gain SPM support with minimal project structure changes by applying an autogenerated layout based on symbolic links technics.
# SPM related files located under `spm` folder at project's root.
# You should **NEVER** modify it manually nor inlude to Xcode's project.

# ### Generate SPM layout

# 1. From **project's root** run:

# `bash scripts/generate_spm_sources_layout.sh`

# 2. Commit Changes

# Repeate those steps each time you delete/add project's files. **Make sure** to have this CI step which will check that `generate_spm_sources_layout.sh` is not broken.

set -e

###IGListDiffKit
Expand Down

0 comments on commit 640d1be

Please sign in to comment.