Skip to content

Commit e3c3683

Browse files
authored
Merge pull request #358 from iainelder/patch-1
Add Quick Start to README
2 parents 0ac5a2f + 4529153 commit e3c3683

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,20 @@ To install from source, download the package, extract and type::
2828

2929
$ pip install .
3030

31+
===========
32+
Quick Start
33+
===========
34+
35+
Use `mprof` to generate a full memory usage report of your executable and to plot it.
36+
37+
.. code-block:: bash
38+
39+
mprof run executable
40+
mprof plot
41+
42+
The plot would be something like this:
43+
44+
.. image:: https://i.stack.imgur.com/ixCH4.png
3145

3246
=======
3347
Usage

0 commit comments

Comments
 (0)