Skip to content

Commit

Permalink
Fixes documentation typos (#6190)
Browse files Browse the repository at this point in the history
* Fix documentation typos

* Fixes warning about resolving Carthage dependencies before generate/build/test with Tuist

* Removes todo about wrapper script as it's already present
  • Loading branch information
vijaytholpadi committed Apr 15, 2024
1 parent 40138c5 commit 159c32e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/docs/guide/introduction/adopting-tuist/new-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ mkdir MyFramework
cd MyFramework
```

The create a `Tuist/Config.swift` file, which will configure Tuist and is used by Tuist to determine the root directory of the project, and a `Project.swift`, where your project will be declared:
Then create a `Tuist/Config.swift` file, which will configure Tuist and is used by Tuist to determine the root directory of the project, and a `Project.swift`, where your project will be declared:

::: code-group
```swift [Project.swift]
Expand Down Expand Up @@ -109,4 +109,4 @@ let config = Config()
:::

> [!IMPORTANT]
> Tuist uses the `Tuist/` directory to determine the root of your project, and from there it looks for other manifest files globbing the directories. We recommend creating those files with your editor of choice, and from that point on, you can use `tuist edit` to edit the project with Xcode.
> Tuist uses the `Tuist/` directory to determine the root of your project, and from there it looks for other manifest files globbing the directories. We recommend creating those files with your editor of choice, and from that point on, you can use `tuist edit` to edit the project with Xcode.
3 changes: 1 addition & 2 deletions docs/docs/guide/project/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,7 @@ tuist generate
```

> [!WARNING] BUILD AND TEST
> If you build and test your project through `tuist build` and `tuist test`
> <!-- TODO: Document how to have a wrapper script that runs carthage update -->
> If you build and test your project through `tuist build` and `tuist test`, you will similarly need to ensure that the Carthage-resolved dependencies are present by running the `carthage update` command before `tuist build` or `tuist test` are run.
### CocoaPods

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/project/directory-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Workspace.swift
- **Workspace.swift:** This manifest represents an Xcode workspace. It's used to group other projects and can also add additional files and schemes.
- **Project.swift:** This manifest represents an Xcode project. It's used to define the targets that are part of the project, and their dependencies.

When interacting with the above project, commads expect to find either a `Workspace.swift` or a `Project.swift` file in the working directory or the directory indicated via the `--path` flag. The manifest should be in a directory or subdirectory of a directory containing a `Tuist` directory, which represents the root of the project.
When interacting with the above project, commands expect to find either a `Workspace.swift` or a `Project.swift` file in the working directory or the directory indicated via the `--path` flag. The manifest should be in a directory or subdirectory of a directory containing a `Tuist` directory, which represents the root of the project.

> [!TIP]
> Xcode workspaces allowed splitting projects into multiple Xcode projects to reduce the likelihood of merge conflicts. If that's what you were using workspaces for, you don't need them in Tuist. Tuist auto-generates a workspace containing a project and its dependencies' projects.
Expand All @@ -45,4 +45,4 @@ When interacting with the above project, commads expect to find either a `Worksp

Tuist also supports SPM package projects. If you are working on an SPM package, you shouldn't need to update anything. Tuist automatically picks up on your root `Package.swift` and all the features of Tuist work as if it was a `Project.swift` manifest.

To get started, run `tuist install` and `tuist generate` in your SPM package. Your project should now have all the same schemes and files that you would see in the vanilla Xcode SPM integration. However, now you can also run [`tuist cache`](/cloud/binary-caching) and have majority of your SPM dependencies and modules precompiled, making subsequent builds extremely fast.
To get started, run `tuist install` and `tuist generate` in your SPM package. Your project should now have all the same schemes and files that you would see in the vanilla Xcode SPM integration. However, now you can also run [`tuist cache`](/cloud/binary-caching) and have majority of your SPM dependencies and modules precompiled, making subsequent builds extremely fast.

0 comments on commit 159c32e

Please sign in to comment.