Skip to content

Commit d63774c

Browse files
Update ReadMe File (#91)
* Update README.md * Create mdbook.yml * Delete .github/workflows/mdbook.yml
1 parent c8e5242 commit d63774c

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
55
### Introduction
66

7-
This is the **Workload Services Framework** repository. The repository contains a set of workloads optimized for Intel(R) Xeon(R) platforms. See the list of supported workloads under the [workload](workload) directory.
7+
Welcome to the **Workload Services Framework** repository. The repository contains a set of workloads optimized for Intel(R) Xeon(R) platforms. You can find the list of supported workloads in the [workload](workload) directory.
88

99
### Prerequisite
1010

11-
- Sync your system date/time. This is required by any credential authorization.
11+
Before you begin, ensure the following:
12+
13+
- Sync your system date and time. This is required for any credential authorization.
1214
- If you are behind a corporate firewall, please setup `http_proxy`, `https_proxy` and `no_proxy` in `/etc/environment`, and source the settings into the current shell environment.
13-
- Run the [`setup-dev.sh`](doc/user-guide/preparing-infrastructure/setup-wsf.md#setup-devsh) script to setup the development host for workload development and evaluation. See [Cloud and On-Premises Setup](doc/user-guide/preparing-infrastructure/setup-wsf.md) for additional SUT setup. SUT stands for System Under Test, or workload test machines.
15+
- Run the [`setup-dev.sh`](doc/user-guide/preparing-infrastructure/setup-wsf.md#setup-devsh) script to setup the development host for workload development and evaluation. Refer to [Cloud and On-Premises Setup](doc/user-guide/preparing-infrastructure/setup-wsf.md) for additional SUT setup. SUT stands for `System Under Test`, or `workload test machines`.
1416

1517
### Evaluate Workload
1618

@@ -34,6 +36,9 @@ The WSF supports multiple validation backends. By default, the [terraform](doc/u
3436

3537
### Build Workload
3638

39+
To build a workload, use the following commands:
40+
41+
3742
```
3843
mkdir -p build
3944
cd build
@@ -45,14 +50,16 @@ make
4550

4651
> TIP: You can specify `BENCHMARK` to limit the repository scope to the specified workload. The build and test operations on all other workloads are disabled. See [Build Options](doc/user-guide/executing-workload/cmake.md) for details.
4752
53+
Alternatively, you can use:
54+
4855
```
4956
cd build
5057
cmake -DBENCHMARK=ResNet-50
5158
make
5259
./ctest.sh -N
5360
```
5461

55-
### See Also
62+
### Additional Resources
5663

5764
- [Build Options](doc/user-guide/executing-workload/cmake.md)
5865
- [Test Options](doc/user-guide/executing-workload/ctest.md)

0 commit comments

Comments
 (0)