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 getting started on macos #1560

Merged
merged 4 commits into from
Mar 7, 2017
Merged

Update getting started on macos #1560

merged 4 commits into from
Mar 7, 2017

Conversation

BillWagner
Copy link
Member

@BillWagner BillWagner commented Feb 15, 2017

update the getting started on Mac topic for the csproj build system

Targeting the csproj branch

/cc @mairaw

Fixes #1648

Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

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

Looks good overall. Left a couple of comments (some are nits) for you to address. In the future, I think we could review this topic to be less verbose with its steps, but something to be looked at later. Thanks!

@@ -29,7 +24,7 @@ it points out the differences for the Windows platform.
## Prerequisites

Before starting, you'll need to install the [.NET Core SDK](https://www.microsoft.com/net/core),
currently in a preview release. The .NET Core SDK includes the latest release
currently in RC4 pre-release. The .NET Core SDK includes the latest release
Copy link
Contributor

Choose a reason for hiding this comment

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

RC4 will not be applicable soon. Change to refer to final version name of the SDK. I think it's .NET Core SDK 1.0.0. @leecow can you confirm?

Also, since this is for Mac, should it link you directly to https://www.microsoft.com/net/core#macos?

Copy link
Member Author

Choose a reason for hiding this comment

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

This one is still open after the last commit. Awaiting @leecow for the correct version.

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's just leave as .NET Core SDK right now with no version indication and we can fix that later when we know more @BillWagner

create a `test-library` directory. You can do this either using the terminal
in VS code, or by clicking on the parent folder in VS Code and selecting the
"New Folder" icon.
directory. In VS Code, open the *golden* directory. This directory is the root of your solution. Run the `dotnet new` command to create a new solution:
Copy link
Contributor

Choose a reason for hiding this comment

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

perhaps link to the dotnet-new topic? if you do, link to the one not in preview3 since we'll be moving things soon.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.


This creates a library project, with two files: *library.csproj* and
*Class1.cs* in the *library* directory. You want that library project
included in your solution. Run the `dotnet sln` command to add the newly
Copy link
Contributor

Choose a reason for hiding this comment

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

same here but re. dotnet sln

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed. Note: This now must wait until the preview 3 folder merges with the tools folder.

@@ -29,7 +24,7 @@ it points out the differences for the Windows platform.
## Prerequisites

Before starting, you'll need to install the [.NET Core SDK](https://www.microsoft.com/net/core),
currently in a preview release. The .NET Core SDK includes the latest release
currently in RC4 pre-release. The .NET Core SDK includes the latest release
of the .NET Core framework and runtime.

You'll also need to install [Visual Studio Code](http://code.visualstudio.com).
Copy link
Contributor

Choose a reason for hiding this comment

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

Line 34. is that really needed (You can find the links to all of these at the .NET home page)?

We already have the links to SDK and VS Code earlier in the paragraph.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

```

The `library` node specifies that this dependency should resolve to a project
in the current workspace. Without explicitly specifying this, it's possible
that the test project would build against a NuGet package of the same name.

Now that the dependencies have been properly configured, let's create
the tests for your library. Open `Tests.cs` and
the tests for your library. Open `UnitTest1.cs` and
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: there are still some files styled with backticks versus italic

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

In your terminal, cd to the `golden/src/app` directory. Run `dotnet new`
to create a new console application.
In your terminal run `dotnet new console -o app`
to create a new console application. This proejct is also
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: proejct

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

dotnet add test-library/test-library.csproj reference library/library.csproj
```

Or, you can manually edit the test-library.csproj file and add the
Copy link
Contributor

Choose a reason for hiding this comment

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

style test-library.csproj

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

@BillWagner BillWagner merged commit b973eb6 into dotnet:master Mar 7, 2017
@BillWagner BillWagner deleted the update-getting-started-on-macos branch March 7, 2017 13:10
BillWagner added a commit that referenced this pull request Mar 7, 2017
* Updated publishing getting started

* Converted project.json to MSBuild

* Updated csproj files to default.

* Revised VSCode topic for MSBuild-based projects

* Tutorials revised for *.csproj projects (#1488)

* Converted some project.json projects

* Replaced csproj project file.

* Updated publishing getting started

* Converted project.json to MSBuild

* Updated csproj files to default.

* Revised VSCode topic for MSBuild-based projects

* Tutorials revised for *.csproj projects (#1488)

* Remove project-json.md (#1520)

* remove doc

* changed to redirect per feedback

* updates, remove from toc

* Updated library examples for csproj.

* Revised xml doc comments topic for csproj

* Addressed comments, fixed some other issues.

* Converted samples to csproj.

* Modified build-related information.

* Addressed comments

* Changed relative URLs to absolute

* Changed links from github to docs

* Update fsharp/tutorials/getting-started-command-line (#1521)

* Updated publishing getting started

* Converted project.json to MSBuild

* Updated csproj files to default.

* Revised VSCode topic for MSBuild-based projects

* Tutorials revised for *.csproj projects (#1488)

* fsharp update to 004769

* fixing --

* undoing --

* address feedback

* addressed nits

* remove global.json add dotnet sln

* add directory output

* add dash to command line in code.

* fixing feedback

* change ms.date

* Update mstest tutorial for csproj (#1531)

* Remove project-json.md (#1520)

* remove doc

* changed to redirect per feedback

* updates, remove from toc

* Update testingng with MSTest for csproj

This topic now mirrors the unit testing with dotnet test and xunit.

* update topic for multiple platforms

This meant updating the index file, the TOC, and adding redirection due
to the file name change.

* Add the meta tag to redirect LiveFyre comments.

* Update per feedback

* Final review and proofread

* Update per feedback on PR #1538

* respond to feedback.

* fixed product name

* Revised out parameter modifier for C# 7

* Corrected bad code example links.

* Fixed one more broken link.

* Fixed alert.

* C# 7 revision of throw

* Corrected code dropout in Lambda Expressions topic.

* Fixed bad code snippet end tag

* project migration from project.json to csproj

* Revised for csproj migration

* Replaced incorrect version of csproj file

* Additional topic added

* Samples ported to MSBuild

* Fix typo

* bringing changes back

* Update pattern matching to fix a couple small issues (#1612)

* Update pattern matching to fix a couple small issues

1. Update feature name for pattern matching (issue #1479)
2. Update description of match expressions to explain that match
expressions in the wrong order generate a compiler error (Issue #1585)

* fix build issues.

Directory move because the solution directory isn’t needed.

* missed one set of build errors.

* update to the 1.1 meta package.

* temporarily disable enable_incremental_build (#1643)

* Addressed review comments

* Incorporated review comments

* removing test protocol doc (#1615)

* uses raw version of sampleQuotes.txt in link (#1652)

This makes it easier to `wget` the file.

* dotnet new updates for MSBuild/csproj (#1649)

* Update index.md

* Update index.md

* Update dependencies.md

* Update index.md

* Update dependencies.md

* Update dotnet.md

* Update index.md

* Update dependencies.md

* Update using-with-xplat-cli-msbuild-folders.md

* Update getting-started-command-line.md

* Update with-visual-studio-code.md

* Update attributes.md

* Update console-teleprompter.md

* Update console-webapiclient.md

* Update attributes.md

* Update inheritance.md

* Update string-interpolation.md

* Update working-with-linq.md

* Update working-with-linq.md

* Update dotnet-migrate.md

* Update using-with-xplat-cli-msbuild-folders.md

* Update using-with-xplat-cli-msbuild-folders.md

* Update dotnet-new.md

* Update dotnet-add-package.md

* Update dotnet-add-reference.md

* Update dotnet-build.md

* Update dotnet-add-reference.md

* Update dotnet-add-package.md

* Update dotnet-clean.md

* Update dotnet-build.md

* Update dotnet-clean.md

* Update dotnet-install-script.md

* Update dotnet-build.md

* Update dotnet-build.md

* Update dotnet-install-script.md

* Update dotnet-list-reference.md

* Update dotnet-msbuild.md

* Update dotnet-new.md

* Update dotnet-nuget-delete.md

* Update dotnet-nuget-locals.md

* Update dotnet-msbuild.md

* dotnet command updates

* Update broken xref

* Update dotnet-pack.md

* Update dotnet-publish.md

* Update using-with-xplat-cli-msbuild-folders.md

* Update with-visual-studio-code.md

* 💥 removing preview3 folder (#1650)

* test redirection with document id

removing dotnet-new from preview3

* 💥 removing preview3 folder

* removed warnings and RC4 mentions

fixing build issues

fixing more build issues

* addressed feedback

more fixes

* rebase and fixes

* fixes

* cleanup

* fix broken link

* Migration and build, publish & run fixes (#1592)

* Migration and build, publish & run fixes

This adds the migraiton document into a migration folder under the
Preview 3 folder. The migration document covers the migration from
project.json to csproj using the automated tools, points to the old DNX
migration for those people that still use that and offers some advice on
getting from pre-RC4 csproj to RC4 (and thus RTW) csproj formats.

The change also adds some content to the dotnet build, dotnet run and
dotnet publish documents to make sure that their differences are clearly
outlined.

Fixes #1512, #1509, #1515

* Fixing broken links

* Responding to PR feedback

* Responding to PR feedback.

* Resolving build breaks

* Fixing build breaks...again.

* some updates

* fixed toc entry

* addressed feedback + fixes

* more fixes

* few more fixes

* removing preview3 links

* Update getting started on macos (#1560)

* update getting started for csproj build system.

Updates all the application code,
the text in the MD file,
and the updated VS Code debugging settings.

* Update for new VS code extension behavior.

* respond to feedback.

* remove version specific notes on the SDK.

* Update the docker getting started topic. (#1503)

* Update the docker getting started topic.

* fix build errors

And update Docker build instructions

* update instructions to use dotnet add package

* Update Unit Testing with XUnit (#1487)

* Remove project-json.md (#1520)

* remove doc

* changed to redirect per feedback

* updates, remove from toc

* run dotnet migrate

* build and run tests

* move projects to the correct updated location

* Update project files and code.

* fix a file name.

* mis-typed the region name.

* proofread and update.

This is ready for review and mergning.

* update instructions to use the new CLI command.

* use updated commands

the older commands still work, but it’s better to standardize on the
new names.

* remove note about .NET Core 1.0

* update for correct xUnit branding.

* small fixes (#1655)

* Documented C# when keyword (#1647)

* documented when keyword

* Incorporated review comments

* Switch statement revised for C# 7 (#1640)

* Switch statement revised for C# 7

* Fixed bad links

* Changed 'switch expression' to 'match expression'

* Addressed review comments.

* Added code snippet tags.

* modified code

* update dotnet-install script topic (#1618)

* update dotnet-install script

* fixed word dropout

* Changes to dotnet new (#1637)

* changes to dotnet new

* removed current dir from the summary

* a few more edits

* fix two broken links. (#1657)

* fix two broken links.

* fix more bad links.

* removing RC4 from the menu

* more fixes
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