Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: fixed commands and grammar #103

Merged
merged 1 commit into from
Dec 15, 2024
Merged

readme: fixed commands and grammar #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ or in conda environment, use

$ conda install -c conda-forge asv

If you're not using conda, you also needs to have ``virtualenv``
If you're not using conda, you also need to have ``virtualenv``
installed.

::
Expand All @@ -52,20 +52,20 @@ installed.
Running the benchmarks
^^^^^^^^^^^^^^^^^^^^^^

To quickly try out the benchmarks (e.g. while developing a new benchmark
you can run it against a single commit on sympy master:
To quickly try out the benchmarks (e.g., while developing a new benchmark),
you can run it against a single commit on SymPy master.

::

$ asv --quick "HEAD^!"
$ asv run --quick "HEAD^!"

If you work with ``conda`` , you should change the
If you work with ``conda``, you should change the
``"environment_type"`` entry in ``asv.conf.json`` from ``"virtualenv"``
to ``"conda"``. Or you can use,

::

$ asv --config asv.conf.conda.json --quick "HEAD^!"
$ asv run --config asv.conf.conda.json --quick "HEAD^!"

You can also run a specific benchmark based on the function or class
name in ``benchmarks/`` or ``slow_benchmarks/`` folder.
Expand Down