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

Update toolchain version, script, and README.md #96

Merged
merged 5 commits into from
Oct 21, 2020

Conversation

MaxDesiatov
Copy link
Contributor

@MaxDesiatov MaxDesiatov commented Oct 7, 2020

The toolchain snapshot suggested in README.md is outdated. I think we should recommend using the script to install it automatically.

Resolves #95.

@MaxDesiatov MaxDesiatov added the documentation Improvements or additions to documentation label Oct 7, 2020
@MaxDesiatov
Copy link
Contributor Author

Another option would be to suggest carton as the default build tool for end users. WDYT?

@github-actions
Copy link

github-actions bot commented Oct 7, 2020

Time Change: -96.5ms (1%)

Total Time: 8,702.5ms

ℹ️ View Unchanged
Test name Duration Change
Serialization/Write JavaScript number directly 157ms -0.25ms
Serialization/Write JavaScript string directly 159.5ms -4.5ms (2%)
Serialization/Swift Int to JavaScript 2,879.25ms +11.5ms (0%)
Serialization/Swift String to JavaScript 2,882.25ms -46.75ms (1%)
Object heap/Increment and decrement RC 2,624.5ms -56.5ms (2%)

performance-action

@carson-katri
Copy link
Member

I suppose both could be mentioned, then they can choose what fits their needs best?

@kateinoigakukun
Copy link
Member

I think we need to provide two section, the first is for users of JavaScriptKit and the second is for contributors of JavaScriptKit.
IMO, we should keep swiftenv installation section for users of JSKit. But the installation script section is helpful for new contributors.

@MaxDesiatov MaxDesiatov changed the title Mention the install-toolchain.sh script in README.md Update toolchain version, script, and README.md Oct 19, 2020
@MaxDesiatov MaxDesiatov requested a review from a team October 19, 2020 16:47
@MaxDesiatov
Copy link
Contributor Author

That's updated, README.md now lists steps for newcomers that allow them to use carton, but keeps a separate section for advanced use cases and local development.

@MaxDesiatov MaxDesiatov force-pushed the toolchain-script-readme branch from c413132 to 045f5d1 Compare October 19, 2020 16:51
@MaxDesiatov MaxDesiatov force-pushed the toolchain-script-readme branch from 045f5d1 to fb798a5 Compare October 19, 2020 16:55
@@ -18,13 +18,16 @@ fi

case $(uname -s) in
Darwin)
toolchain_download="$swift_tag-osx.tar.gz"
toolchain_download="$swift_tag-macos-x86_64.tar.gz"
echo '-macos' >> .swift-version
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need this line?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still waiting for the new 5.3 toolchain to be tagged tonight that fixes this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's cleaned up now, ready for review.

README.md Outdated
```sh
$ ./scripts/install-toolchain.sh
$ swift --version
Swift version 5.3-dev (LLVM 09686f232a, Swift 5a196c7f13)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think vendor name can be updated 👍

Copy link
Member

@kateinoigakukun kateinoigakukun Oct 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found that swiftwasm/swift#1921 is not included in 5.3 branch 😢 But now, it's ok without SwiftWasm vendor name...

@MaxDesiatov MaxDesiatov merged commit 766d2e1 into main Oct 21, 2020
@MaxDesiatov MaxDesiatov deleted the toolchain-script-readme branch October 21, 2020 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Errors building example: undefined symbols
3 participants