From 21fb4d1c4db04e7a8a07ca13922df3ab3fc8b7f1 Mon Sep 17 00:00:00 2001 From: Julian Hammer Date: Tue, 25 Sep 2018 10:37:09 +0200 Subject: [PATCH] changed to rst readme --- MANIFEST.in | 2 +- README.md => README.rst | 16 ++++++++-------- setup.py | 7 +++---- 3 files changed, 12 insertions(+), 13 deletions(-) rename README.md => README.rst (60%) diff --git a/MANIFEST.in b/MANIFEST.in index c1a7121..9d5d250 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,2 @@ include LICENSE -include README.md +include README.rst diff --git a/README.md b/README.rst similarity index 60% rename from README.md rename to README.rst index 778e00d..d55e4d2 100644 --- a/README.md +++ b/README.rst @@ -1,17 +1,17 @@ -# asmbench +asmbench +======== A benchmark toolkit for assembly instructions using the LLVM JIT. -## Usage +Usage +===== To benchmark latency and throughput of a 64bit integer add use the following command: -``` -python -m asmbench 'add {src:i64:r}, {srcdst:i64:r}' -``` + +``python -m asmbench 'add {src:i64:r}, {srcdst:i64:r}'`` To benchmark two instructions interleaved use this: -``` -python -m asmbench 'add {src:i64:r}, {srcdst:i64:r}' 'sub {src:i64:r}, {srcdst:i64:r}' -``` + +``python -m asmbench 'add {src:i64:r}, {srcdst:i64:r}' 'sub {src:i64:r}, {srcdst:i64:r}'`` To find out more add `-h` for help and `-v` for verbose mode. diff --git a/setup.py b/setup.py index c517376..e13bba2 100644 --- a/setup.py +++ b/setup.py @@ -1,19 +1,18 @@ from setuptools import setup, find_packages -with open('README.md') as f: +with open('README.rst') as f: long_description = f.read() setup( name='asmbench', - version='0.1.1', + version='0.1.1.2', packages=find_packages(exclude=['contrib', 'docs', 'tests*']), - url='', + url='https://github.com/RRZE-HPC/asmbench', license='AGPLv3', author='Julian Hammer', author_email='julian.hammer@fau.de', description='A Benchmark Toolkit for Assembly Instructions Using the LLVM JIT', - long_description_content_type='text/markdown', long_description=long_description, install_requires=['llvmlite>=0.23.2', 'psutil'], extras_require={