Replace python -m v2x with v2x Signed-off-by: Daniel Lim Wee Soong <weesoong.lim@gmail.com>
diff --git a/README.rst b/README.rst index f095db7..b2a5f86 100644 --- a/README.rst +++ b/README.rst
@@ -35,11 +35,11 @@ Usage ----- -After installing v2x, you can run ``python -m v2x`` to use it. +After installing v2x, you can run ``v2x`` to use it. .. code-block:: - python -m v2x -h + v2x -h usage: __main__.py [-h] [--top TOP] [--outfile OUTFILE] [--includes INCLUDES] [--mode {pb_type,model}] input.v [input.v ...] @@ -67,19 +67,19 @@ .. code-block:: - python -m v2x -o adder.pb_type.xml adder.v + v2x -o adder.pb_type.xml adder.v Or, to generate a model xml file, run .. code-block:: - python -m v2x --mode model -o adder.model.xml adder.v + v2x --mode model -o adder.model.xml adder.v v2x expects the module name to be the same as the file name. If it is different, make sure to specifiy it with the ``--top`` argument. .. code-block:: - python -m v2x --top BLOCK -o adder.pb_type.xml adder.v + v2x --top BLOCK -o adder.pb_type.xml adder.v Tests -----