Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SR-12305] "Create an App That Uses a Package" is hard to discover. #4579

Open
dabrahams opened this issue Mar 2, 2020 · 1 comment
Open

Comments

@dabrahams
Copy link
Contributor

Previous ID SR-12305
Radar rdar://problem/59976667
Original Reporter @dabrahams
Type Improvement
Additional Detail from JIRA
Votes 0
Component/s Package Manager
Labels Improvement
Assignee None
Priority Medium

md5: ecf1133683f71b74e3bfba25b96d01df

Issue Description:

The simplest case, and the one that will serve the vast majority of SPM users, is to create an application that uses other packages. But how to do that requires extracting it from a complicated 3-package example in the documentation, and `swift project init --type executable` is not easy to discover. `swift project --help` doesn't give an indication that I can type `swift project init --help` and get detailed help for the init command.

SR-12304 doesn't help, either ;-)

I recommend:

  • The very first example should show how to create a simple executable package.

  • the `--help` text should be amended with something like what's at the end of `git --help` output: “See 'git help <command>' or 'git help <concept>'
    to read about a specific subcommand or concept.”

@hborla
Copy link
Member

hborla commented Mar 3, 2020

@swift-ci create

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants