Skip to content

Commit

Permalink
Refactoring(documents): made feedback guide look like a step-by-step …
Browse files Browse the repository at this point in the history
…instructions.
  • Loading branch information
strizhechenko committed Oct 27, 2017
1 parent a365297 commit cdfaa21
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

## You are programmer similar with git(hub).

Fork this repo and clone it to your host.
1. Fork this repo and clone it to your host.

Next you should create directory describing your system.
2. Next you should create directory describing your system.

You need to look at `lscpu` output of tuned system to see socket count and cpu per socket values (you're probably already know it).
3. You need to look at `lscpu` output of tuned system to see socket count and cpu per socket values (you're probably already know it).

```
mkdir netutils-linux/examples/sockets_${socket_count}_cpus_${cpu_per_socket}_nic_${netdevs_count}
```

If directory already exists and your scenario differs - add `_1` or `_2` suffix.
4. If directory already exists and your scenario differs - add `_1` or `_2` suffix.

For example: `netutils-linux/examples/sockets_2_cpus_8_nic_4/`

Add a README.md based on [README.tmplt.md](https://github.com/strizhechenko/netutils-linux/blob/master/examples/README.tmplt.md) (replace commands with their output).
5. Add a README.md based on [README.tmplt.md](https://github.com/strizhechenko/netutils-linux/blob/master/examples/README.tmplt.md) (replace commands with their output).

```
git status
Expand All @@ -25,4 +25,4 @@ git commit -m "Added(examples): success story of $your_or_your_company_name"
git push origin master
```

Open pull request to this repo.
6. Open pull request to this repo.

0 comments on commit cdfaa21

Please sign in to comment.