Skip to content

Commit 0a004a7

Browse files
Update getting-started.md (#1568)
1 parent be769f8 commit 0a004a7

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/articles/guides/getting-started.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
To get started with BenchmarkDotNet, please follow these steps.
44

5-
## Step 1. Installation
5+
## Step 1. Create a project
6+
Create a new console application.
7+
8+
## Step 2. Installation
69

710
Install BenchmarkDotNet via the NuGet package: [BenchmarkDotNet](https://www.nuget.org/packages/BenchmarkDotNet/)
811

@@ -12,8 +15,8 @@ PM> Install-Package BenchmarkDotNet
1215

1316
Read more about BenchmarkDotNet NuGet packages: @docs.nuget
1417

15-
## Step 2. Design a benchmark
16-
Create a new console application, write a class with methods that you want to measure and mark them with the `Benchmark` attribute. In the following example, we
18+
## Step 3. Design a benchmark
19+
Write a class with methods that you want to measure and mark them with the `Benchmark` attribute. In the following example, we
1720
compare [MD5](https://en.wikipedia.org/wiki/MD5) and [SHA256](https://en.wikipedia.org/wiki/SHA-2) cryptographic hash functions:
1821

1922
```cs
@@ -57,7 +60,7 @@ namespace MyBenchmarks
5760

5861
The `BenchmarkRunner.Run<Md5VsSha256>()` call runs your benchmarks and print results to console output.
5962

60-
## Step 3. View results
63+
## Step 4. View results
6164
View the results. Here is an example of output from the above benchmark:
6265

6366
```ini
@@ -74,7 +77,7 @@ Frequency=2143476 Hz, Resolution=466.5319 ns, Timer=TSC
7477
| Md5 | 25.8010 us | 0.1757 us | 113 B |
7578

7679

77-
## Step 4. Analyze results
80+
## Step 5. Analyze results
7881

7982
Analyze it. In your bin directory, you can find a lot of useful files with detailed information. For example:
8083

@@ -88,4 +91,4 @@ Analyze it. In your bin directory, you can find a lot of useful files with detai
8891
BenchmarkDotNet provides a lot of features which help to high-quality performance research.
8992
If you want to know more about BenchmarkDotNet features, checkout the [Overview](../overview.md) page.
9093
If you want have any questions, checkout the [FAQ](../faq.md) page.
91-
If you didn't find answer for your question on this page, [ask it on gitter](https://gitter.im/dotnet/BenchmarkDotNet) or [create an issue](https://github.com/dotnet/BenchmarkDotNet/issues).
94+
If you didn't find answer for your question on this page, [ask it on gitter](https://gitter.im/dotnet/BenchmarkDotNet) or [create an issue](https://github.com/dotnet/BenchmarkDotNet/issues).

0 commit comments

Comments
 (0)