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

Add new library manual draft and samples #110

Closed
wants to merge 5 commits into from
Closed

Add new library manual draft and samples #110

wants to merge 5 commits into from

Conversation

cartermp
Copy link
Contributor

NOTE: This is now out of date. Refer to #182 for the true version of this.

Adding a draft for a component of the .NET Core library manual with
corresponding buildable samples. This is for building new libraries on .NET Core, without requiring Windows or Visual Studio.

This is related to #77 and addresses one of the scenarios in #46.

/cc @richlander @bleroy

Review on Reviewable

Adding a draft for a component of the .NET Core library manual with
corresponding buildable samples.

Because the original document was written in Markdown, it's in Markdwon
right now.  It will be converted to reStructuredText in another commit.

## How do I target .NET Core?

First things first:
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems unnecessary.

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to add something about prerequisites, such as what you will need to install before following the instructions in this document, even if it's just a pointer to another document?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, good catch. Adding that at the top.

@bleroy
Copy link
Contributor

bleroy commented Nov 11, 2015

Succinct, up-to-date, and not confusing :) Nice!


## How do I target both .NET Core and .NET Framework?

You may need a library to work on .NET Core *and* .NET Framework 4.0 or older. You may also need to use specific libraries available in .NET 4.5 which are unavailble in .NET Core (such as `SYSTEM.FIXME.SOON`). For these scenarios, you will need to specifically target the versions of .NET Framework you support.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: "unavailble" should be unavailable

@cartermp
Copy link
Contributor Author

Addressed feedback pieces aside from talking about how to test things. I have questions myself about what's needed to be able to compile and test different platforms effectively, particularly when those platforms aren't compatible with the same version of Xunit.

Edit: and how to create the NuGet package from the command line so that it's a "release" package and not just something that exists in the /Debug folder.

@cartermp
Copy link
Contributor Author

As of right now, the project that uses Xunit to test is failing on the rc1-final bits. See this issue for Xunit.

@cartermp
Copy link
Contributor Author

Feedback from the Xunit issue:

Xunit test runner needs to use an RC version to be compatible with the final RC1 bits for DNX. Workaround for testing:

> dnvm use 1.0.0-rc1-final -r coreclr
> dnu restore -s https://www.myget.org/F/xunit 
> dnu restore
> cd src/Library
> dnu build
> cd ../../test/LibraryTests
> dnx test

FYI: xunit/xunit#677 (comment)

These instructions should change once we ship rc1-final. We should be able to pull directly from NuGet once that happens.

@cartermp
Copy link
Contributor Author

Updated the text to have instructions for running tests cross-platform. Updated the sample project to use the correct packges as well.

/cc @bleroy @richlander @BethMassi

@cartermp
Copy link
Contributor Author

Open issues remaining:

  • solid story for testing when you're cross-targetting (e.g. .NET Core and .NET Framework 4.0)
  • how to create a Nuget package in a "release" folder so it's obvious that you can publish the package

@cartermp
Copy link
Contributor Author

cartermp commented Dec 2, 2015

Closing out since this was created under the old TOC and under some older principles.

@cartermp cartermp closed this Dec 2, 2015

* `NET20` --> .NET Framework 2.0
* `NET35` --> .NET Framework 3.5
* `NET40` --> .NET Frameowrk 4.0
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: framework

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.

None yet

4 participants