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.

Sign up for GitHub

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

Jump to bottom

Include more detail about the assumptions of the shell #1002

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Include more detail about the assumptions of the shell #1002

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/reference/00-Getting-Started/02-sbt-by-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ out: sbt-by-example.html
sbt by example
--------------

This page assumes you've [installed sbt 1][Setup].
This page assumes you've [installed sbt 1][Setup] and you are running a Bash/UNIX shell on macOS, Linux or WSL ([Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)).
Copy link
Member

Choose a reason for hiding this comment

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

Why does the system shell matter so much here? Are we trying to preclude Windows console?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These instructions would not work on the Windows default console, and some new users might be just confused what this all means and skip the tutorial.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

And many people still don't know about WSL being available on Windows at all.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

for example:
image

Copy link
Member

Choose a reason for hiding this comment

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

If the user is already familiar with Windows console, I don't want them to switch to using WSL.
I'd much rather document touch equivalent on console together, which is

type nul >> build.sbt

?


Let's start with examples rather than explaining how sbt works or why.

Expand Down