Skip to content

Fix md violations #191

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 1 commit into from
Jun 13, 2021
Merged
Changes from all commits
Commits
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
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,30 +15,35 @@ Ensure one of the following frameworks is installed at the latest version.

#### Local Copy

Open a console and change the working directory to the desired project location.
Open a console and change the working directory to the desired project location.

```
$ git clone https://github.com/IntelliTect/EssentialCSharp.git
$ cd ./EssentialCSharp/
git clone https://github.com/IntelliTect/EssentialCSharp.git
cd ./EssentialCSharp/
```

The source code is the most recently published edition of the book and this is the default branch following the clone command. However, you can switch to a different branch, v6.0 for example, with the command:

```
$ git checkout v6.0
git checkout v6.0
```

### Build

**EssentialCSharp.sln** is the project's main solution, open this with Visual Studio and _Build All_.

For those using the command line, build all the projects from the /EssentialCSharp/ directory with these commands:

```
$ dotnet restore EssentialCSharp.sln
$ dotnet build EssentialCSharp.sln
dotnet restore EssentialCSharp.sln
dotnet build EssentialCSharp.sln
```

### Run

Navigate to an individual project in the /EssentialCSharp/src/(project)/ directory and run the code. The example below is for Chapter01 with the user entering _1.1_ to execute the listing number.

To run a listing you must run the the project that contains it. For example, to run Listing 1.1 you must navigate to Chapter01 in the
To run a listing you must run the the project that contains it. For example, to run Listing 1.1 you must navigate to Chapter01 in the
_Solution Explorer_ and set Chapter01 as the startup project. In Rider this can be done by locating the desired project in the _Explorer_ tab, right clicking on the project and clicking _run_.

```
Expand All @@ -56,15 +61,15 @@ Press any key to exit.
$
```

Documentation for .NET CLI tools can be found here:

https://docs.microsoft.com/en-us/dotnet/core/tools/

Documentation for .NET CLI tools can be found here:

<https://docs.microsoft.com/en-us/dotnet/core/tools/>

## Testing

To run all the tests, run `dotnet test` on the command prompt in the EssentialCSharp solution directory on your local computer.

## Build Status

[![Build status](https://github.com/IntelliTect/EssentialCSharp/actions/workflows/Branch%20v9.0%20-%20Windows.yml/badge.svg?branch=v9.0)](https://github.com/IntelliTect/EssentialCSharp/actions/workflows/Branch%20v9.0%20-%20Windows.yml)<br>
[![Build status](https://github.com/IntelliTect/EssentialCSharp/actions/workflows/Branch%20v9.0%20-%20Linux.yml/badge.svg?branch=v9.0)](https://github.com/IntelliTect/EssentialCSharp/actions/workflows/Branch%20v9.0%20-%20Linux.yml)