Skip to content

Commit 134675b

Browse files
authored
Merge pull request #210 from Roger-luo/readme
Polish Readme
2 parents d74c567 + 33f6882 commit 134675b

File tree

4 files changed

+18
-1424
lines changed

4 files changed

+18
-1424
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# BenchmarkTools.jl
22

3+
[![][docs-stable-img]][docs-stable-url]
4+
[![][docs-dev-img]][docs-dev-url]
35
[![Build Status](https://github.com/JuliaCI/BenchmarkTools.jl/workflows/CI/badge.svg)](https://github.com/JuliaCI/BenchmarkTools.jl/actions/workflows/CI.yml?query=branch%3Amaster)
46
[![Code Coverage](https://codecov.io/gh/JuliaCI/BenchmarkTools.jl/branch/master/graph/badge.svg?label=codecov&token=ccN7NZpkBx)](https://codecov.io/gh/JuliaCI/BenchmarkTools.jl)
57

@@ -11,10 +13,19 @@ The CI infrastructure for automated performance testing of the Julia language is
1113

1214
## Installation
1315

14-
To install BenchmarkTools, you can run the following:
16+
<p>
17+
BenchmarkTools is a &nbsp;
18+
<a href="https://julialang.org">
19+
<img src="https://raw.githubusercontent.com/JuliaLang/julia-logo-graphics/master/images/julia.ico" width="16em">
20+
Julia Language
21+
</a>
22+
&nbsp; package. To install BenchmarkTools,
23+
please <a href="https://docs.julialang.org/en/v1/manual/getting-started/">open
24+
Julia's interactive session (known as REPL)</a> and press <kbd>]</kbd> key in the REPL to use the package mode, then type the following command
25+
</p>
1526

1627
```julia
17-
Pkg.add("BenchmarkTools")
28+
pkg> add BenchmarkTools
1829
```
1930

2031
## Documentation
@@ -124,3 +135,8 @@ This package was authored primarily by Jarrett Revels (@jrevels). Additionally,
124135
- Andreas Noack, for statistics help and investigating weird benchmark time distributions
125136
- Oscar Blumberg, for discussions on noise robustness
126137
- Jiahao Chen, for discussions on error analysis
138+
139+
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
140+
[docs-dev-url]: https://JuliaCI.github.io/BenchmarkTools.jl/dev/
141+
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
142+
[docs-stable-url]: https://JuliaCI.github.io/BenchmarkTools.jl/stable

doc/linuxtips.md

Lines changed: 0 additions & 253 deletions
This file was deleted.

0 commit comments

Comments
 (0)