Skip to content

Commit 4529153

Browse files
authored
Add Quick Start to README
Adapted from an answer to "Graphing a process's memory usage" on [Stack Overflow](https://stackoverflow.com/a/62876993/111424). Memory profiler is exactly the tool I've been looking for. But the Usage section of the README makes it seem so complicated to use that it scared me away! The Stack Overflow answer gets straight to the point and shows how simple it is to use. I think it deserves to be at the top of the README.
1 parent 0ac5a2f commit 4529153

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)