try/README.md

# Try .NET <img src ="https://user-images.githubusercontent.com/2546640/56708992-deee8780-66ec-11e9-9991-eb85abb1d10a.png" width="80px" alt="dotnet bot in space" align ="right">
|| [**Basics**](#basics) • [**Experiences**](#experiences) || [**Setup**](#setup) • [**Getting Started**](#getting-started) || [**Samples**](Samples) ||

![Try_.NET Enabled](https://img.shields.io/badge/Try_.NET-Enabled-501078.svg)

*Please note that the dotnet try global tool isn't listed on NuGet yet. We will post the link as soon as it is available.*


## Basics
**What is Try .NET**: Try .NET is an interactive documentation generator for .NET Core.

**Please Note**: At the moment Try .NET only works with C# documentation. 

**What is the repo for?**
- A place where you can post issues about [Try .NET](https://github.com/dotnet/try/issues).
- **Note:** The code for Try .NET is not currently hosted on GitHub.*(Coming soon)*

## Experiences 
 Use Try .NET to create executable C# snippets for your websites or,  interactive markdown files that users can run on their machine. 

**Websites** 

Microsoft Docs uses Try .NET to create interactive documentation. Users can run and edit code in the browser.
![Try NET_online](https://user-images.githubusercontent.com/2546640/57144765-c850cc00-6d8f-11e9-982d-50d2b6dc3591.gif)

**Interactive .NET documentation**

Try .NET enables .NET developers to write documentation containing interactive code snippets using Markdown or HTML.

To make your Markdown files interactive, you will need the [.NET Core 3.0 SDK](https://dotnet.microsoft.com/download/dotnet-core/3.0), the dotnet try global tool (*coming soon*) and [Visual Studio](https://visualstudio.microsoft.com/), [VS Code](https://code.visualstudio.com/), or another editor of your choice. 
![interactive_doc](https://user-images.githubusercontent.com/2546640/57158389-47a2c780-6db1-11e9-96ad-8c6e9ab52853.png)

## Setup

Before you get can start creating interactive documentation, you will need to install the following: 
- [.NET Core 3.0 SDK](https://dotnet.microsoft.com/download/dotnet-core/3.0)and [2.1](https://dotnet.microsoft.com/download/dotnet-core/2.1) currently dotnet try global tool targets 2.1. 
- [dotnet try global tool] (*coming soon*)
Once you have successfully installed `dotnet try`, enter the command `dotnet try -h` to see a list of commands:

| Command        | Purpose                                                             |
|----------------|---------------------------------------------------------------------|
| `demo`         | Learn how to create Try .NET content with an interactive demo       |
| `verify`       | Verify Markdown files in the target directory and its children.     |

## Getting Started

You can get started using either one of the options below. 

**Option1**: `dotnet try demo` 
- Create a new folder.
- `cd` to your new folder.
- Run command `dotnet try demo` 

**Option 2**: Starting from scratch.
1. Go to the terminal and create a folder called `mydoc`.
2. `cd` to the `mydoc` folder and create a new console app by running the following command:
 ```console
> dotnet new console -o myApp
```
This will create a console app with the files `mydoc.csproj` and `Program.cs`.

3. Open `mydoc`folder in Visual Studio Code. 

4. Create a file called `doc.md`. Inside that file, add some text and a code fence:

````markdown
# My Interactive Document:

```cs --source-file ./mydoc/Program.cs --project ./mydoc/mydoc.csproj
```
````

5. Now, navigate back to the `mydoc` folder and run the following command:

```console
> dotnet try
```

You can now run your sample code in the browser.

**Option 3**: Explore our [samples folders](Samples). 
- Read our quick [setup guide](Samples/Setup.md).