Skip to content

Commit 273bcef

Browse files
committed
Some fixes to README formatting and structure.
Change-Id: Ifb16efa00407656c2c5b74e57d303b3d22cd0659
1 parent 2fb892c commit 273bcef

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ International Symposium on Performance Analysis of Systems and Software
1414

1515
Requirements:
1616
-------------------
17-
We *highly* recomend that users use the provided Docker image, available for download
18-
[here](https://hub.docker.com/repository/docker/xyzsam/gem5-aladdin). This will solve
19-
basically all environment issues. If you cannot use Docker, then read on.
17+
We *highly* recommend that users use the provided Docker image, available for
18+
download [here](https://hub.docker.com/repository/docker/xyzsam/gem5-aladdin).
19+
This will solve basically all environment issues. If you cannot use Docker,
20+
then read on.
2021

2122
1. LLVM 6.0 and Clang 6.0 64-bit. Users cannot download a pre-built package
2223
because the Release build type strips value names from LLVM IR, and
@@ -25,11 +26,12 @@ basically all environment issues. If you cannot use Docker, then read on.
2526
2. GCC 5.4 or later.
2627
3. CMake 2.8.12 or newer.
2728

28-
Build:
29+
Changelog:
2930
-----------------
30-
**Feburary 2020: New features**
3131

32-
## Breaking changes from v1.2 to v2.0: ##
32+
### Feburary 2020: v2 new features ###
33+
34+
**Breaking changes from v1.2 to v2.0:**
3335

3436
* LLVM-Tracer now uses LLVM 6.0. Support for all previous versions of LLVM
3537
have been removed. Minor versions 6.0.0 and 6.0.1 have been tested to work.
@@ -38,7 +40,7 @@ Build:
3840
it is *highly* recommended that you build the `Debug` build type by adding
3941
the cmake flag `-DCMAKE_BUILD_TYPE=Debug`.
4042

41-
## C++ support ##
43+
#### C++ support ####
4244

4345
LLVM-Tracer now supports C++ for uninstrumented code! Users can write C++
4446
to build applications and only have LLVM-Tracer instrument and generate
@@ -50,14 +52,16 @@ the class's constructor.
5052

5153
See playground/test.cc for a live example.
5254

53-
## Multithreading support ##
55+
#### Multithreading support ####
5456

5557
LLVM-Tracer can now trace multithreaded applications. Each thread should call
5658
the `llvmtracer_set_trace_name` API first to assign a unique name for the
5759
dynamic trace file that will be produced.
5860

5961
See playground/multithreading.cc for an example.
6062

63+
### November 2016: v1.2 changelog ###
64+
6165
**Breaking changes from v1.1 to v1.2:**
6266

6367
* CMake is no longer optional. LLVM-Tracer only supports CMake for building.
@@ -67,6 +71,9 @@ See playground/multithreading.cc for an example.
6771
`lib/` instead of `full-trace/` and `profile-func/`. The `BUILD_ON_SOURCE`
6872
option has been removed.
6973

74+
Build:
75+
-----------------
76+
7077
CMake is a configure tool which allows you to do out-of-source build.
7178
LLVM-Tracer requires CMake newer than 2.8.12. By default, CMake
7279
searches for LLVM 6.0.

0 commit comments

Comments
 (0)