Skip to content

Commit 39472e6

Browse files
authored
Update README.md (AtsushiSakai#732)
* Update README.md Updated the sponsors correctly * Update README.md Remove the tag. * Update README.md Updated development references and styled the single line codes in "How to use" section * Update README.md Styled single-line comments using syntax highlighting for markdown
1 parent 3816348 commit 39472e6

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,9 @@ Python codes for robotics algorithm.
7070
* [Contribution](#contribution)
7171
* [Citing](#citing)
7272
* [Support](#support)
73-
* [Sponsors](#Sponsors)
73+
* [Sponsors](#sponsors)
7474
* [JetBrains](#JetBrains)
75+
* [1Password](#1password)
7576
* [Authors](#authors)
7677

7778
# What is this?
@@ -107,15 +108,15 @@ For running each sample code:
107108

108109
For development:
109110

110-
- pytest (for unit tests)
111+
- [pytest](https://pytest.org/) (for unit tests)
111112

112-
- pytest-xdist (for parallel unit tests)
113+
- [pytest-xdist](https://pypi.org/project/pytest-xdist/) (for parallel unit tests)
113114

114-
- mypy (for type check)
115+
- [mypy](http://mypy-lang.org/) (for type check)
115116

116-
- sphinx (for document generation)
117+
- [sphinx](https://www.sphinx-doc.org/) (for document generation)
117118

118-
- pycodestyle (for code style check)
119+
- [pycodestyle](https://pypi.org/project/pycodestyle/) (for code style check)
119120

120121
# Documentation
121122

@@ -131,18 +132,24 @@ All animation gifs are stored here: [AtsushiSakai/PythonRoboticsGifs: Animation
131132

132133
1. Clone this repo.
133134

134-
> git clone https://github.com/AtsushiSakai/PythonRobotics.git
135+
```terminal
136+
git clone https://github.com/AtsushiSakai/PythonRobotics.git
137+
```
135138

136139

137140
2. Install the required libraries.
138141

139-
using conda :
142+
- using conda :
140143

141-
> conda env create -f requirements/environment.yml
144+
```terminal
145+
conda env create -f requirements/environment.yml
146+
```
142147

143-
using pip :
148+
- using pip :
144149

145-
> pip install -r requirements/requirements.txt
150+
```terminal
151+
pip install -r requirements/requirements.txt
152+
```
146153

147154

148155
3. Execute python script in each directory.
@@ -614,7 +621,7 @@ If you use this project's code for your academic work, we encourage you to cite
614621

615622
If you use this project's code in industry, we'd love to hear from you as well; feel free to reach out to the developers directly.
616623

617-
# Supporting this project
624+
# <a id="support"></a>Supporting this project
618625

619626
If you or your company would like to support this project, please consider:
620627

@@ -626,9 +633,9 @@ If you or your company would like to support this project, please consider:
626633

627634
If you would like to support us in some other way, please contact with creating an issue.
628635

629-
## Sponsors
636+
## <a id="sponsors"></a>Sponsors
630637

631-
### [JetBrains](https://www.jetbrains.com/)
638+
### <a id="JetBrains"></a>[JetBrains](https://www.jetbrains.com/)
632639

633640
They are providing a free license of their IDEs for this OSS development.
634641

0 commit comments

Comments
 (0)