Skip to content

Add Getting Started Page for Users #2521

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

Merged
merged 3 commits into from
Jun 1, 2017
Merged

Conversation

Varunram
Copy link
Contributor

Intended as a fix for #1673.
Didn't know where to add the file, so put it under docs/usage/
Thanks!

@felixmulder felixmulder requested a review from biboudis May 24, 2017 11:44
Copy link
Contributor

@biboudis biboudis left a comment

Choose a reason for hiding this comment

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

First of all thanks for contributing this page! I think that most of this information is written on our landing page and the rest are on the contributions' Getting Started.

However, I feel that your last part: Generating Documentation can be added at the end of the contributions' Getting Started page.

WDYT @felixmulder?

@felixmulder
Copy link
Contributor

@biboudis: sounds good to me 👍

@Varunram
Copy link
Contributor Author

Awesome! Will do the changes right away. Sorry for being late!

@Varunram
Copy link
Contributor Author

@biboudis Changes done as requested. Thanks for your time!

@biboudis
Copy link
Contributor

biboudis commented May 31, 2017

Perfect. I think the file docs/docs/usage/getting-started.md is not needed at all. After that we can merge @felixmulder, right?

@Varunram
Copy link
Contributor Author

@biboudis Yeah, that's what I was thinking too. But since @felixmulder raised an issue I put in a new page. Waiting for Felix's review

@biboudis
Copy link
Contributor

@Varunram let's add the new information that is documented on http://dotty.epfl.ch/#getting-started

Namely brew install lampepfl/brew/dotty for Mac and getting the latest release for the rest. Put that before the Getting Dotty section, titled Install Dotty.

Also, don't forget to add the necessary entry in https://github.com/lampepfl/dotty/blob/master/docs/sidebar.yml
to create the new navigation option.

@Varunram
Copy link
Contributor Author

@biboudis Done!

Copy link
Contributor

@biboudis biboudis left a comment

Choose a reason for hiding this comment

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

LGTM!

Thanks @Varunram!

should contain `1.8`.


Install Dotty
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you make it "Option 1: Install Dotty"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, will do :)


If you're a Linux or Windows user, download the [latest release](https://github.com/lampepfl/dotty/releases). Optionally add path of the folder `bin/` to the system environment variable `PATH`.

Getting Dotty
Copy link
Contributor

@biboudis biboudis May 31, 2017

Choose a reason for hiding this comment

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

and maybe "Option 2: Using Dotty directly from source"

@Varunram
Copy link
Contributor Author

Thanks a ton for your patience! Really appreciate it :)

@biboudis biboudis merged commit 983202b into scala:master Jun 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants