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.

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

a few cosmetic fixes for README.md. #134

Merged
merged 1 commit into from
Jul 22, 2024
Merged
Changes from all commits
Commits
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
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ apt install -y python3-rosdoc2
#### Installation from PyPI

You may also install rosdoc2 from [PyPI](https://pypi.org/project/rosdoc2).
If you do so, we recommend you install and use it from a [virtualenv][].
If you do so, we recommend you install and use it from a [virtualenv](https://docs.python.org/3/library/venv.html).

```
python3 -m pip install rosdoc2
Expand All @@ -64,7 +64,7 @@ python3 -m pip install rosdoc2
#### Installation from source

You can also use pip to install rosdoc2 from source.
Again, we recommend you install and use it from a [virtualenv][].
Again, we recommend you install and use it from a [virtualenv](https://docs.python.org/3/library/venv.html).

```
python3 -m pip install --upgrade 'git+https://github.com/ros-infrastructure/rosdoc2@main'
Expand Down Expand Up @@ -223,9 +223,6 @@ passed tests, run:
python3 -m pytest -rP --log-level=DEBUG -k full_package
```




## Contributing

TODO
Expand Down