Skip to content

Commit 5103c28

Browse files
jcarpentjorisv
authored andcommitted
readme: add Joris + typos
1 parent 46c4a5a commit 5103c28

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@ EigenPy — Versatile and efficient Python bindings between Numpy and Eigen
1010
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"></a>
1111
</p>
1212

13-
**EigenPy** is an open source framework which allows to bind the famous [Eigen](http://eigen.tuxfamily.org) C++ library in Python via Boost.Python.
13+
**EigenPy** is an open-source framework that allows the binding of the famous [Eigen](http://eigen.tuxfamily.org) C++ library in Python via Boost.Python.
1414

1515
**EigenPy** provides:
16-
- full memory sharing between Numpy and Eigen avoiding memory allocation
16+
- full memory sharing between Numpy and Eigen, avoiding memory allocation
1717
- full support Eigen::Ref avoiding memory allocation
1818
- full support of the Eigen::Tensor module
1919
- exposition of the Geometry module of Eigen for easy code prototyping
20-
- standard matrix decomposion routines of Eigen such as the Cholesky decomposition, SVD decomposition, QR decomposition, and etc.
20+
- standard matrix decomposion routines of Eigen such as the Cholesky decomposition, SVD decomposition, QR decomposition, etc.
2121
- full support of SWIG objects
2222
- full support of runtime declaration of Numpy scalar types
2323
- extended API to expose std::vector types
2424
- full support of vectorization between C++ and Python (all the hold objects are properly aligned in memory)
2525

2626
## Setup
2727

28-
The installation of **EigenPy** on your computer is made easy for Linux/BSD, Mac OS X and Windows environments.
28+
The installation of **EigenPy** on your computer is made easy for Linux/BSD, Mac OS X, and Windows environments.
2929

3030
### The Conda approach
3131

@@ -36,7 +36,7 @@ conda install eigenpy -c conda-forge
3636

3737
### Ubuntu
3838

39-
You can easily install **EigenPy** from binairies.
39+
You can easily install **EigenPy** from binaries.
4040

4141
#### Add robotpkg apt repository
4242
1. Add robotpkg as source repository to apt:
@@ -47,7 +47,7 @@ sudo sh -c "echo 'deb [arch=amd64] http://robotpkg.openrobots.org/packages/debia
4747
```
4848
curl http://robotpkg.openrobots.org/packages/debian/robotpkg.key | sudo apt-key add -
4949
```
50-
3. You need to run at least once apt update to fetch the package descriptions:
50+
3. You need to run at least one apt update to fetch the package descriptions:
5151
```bash
5252
sudo apt-get update
5353
```
@@ -58,12 +58,12 @@ sudo apt-get update
5858
```bash
5959
sudo apt install robotpkg-py35-eigenpy
6060
```
61-
where 35 should be replaced by the python 3 you want to work this (e.g. `robotpkg-py36-eigenpy` to work with Python 3.6).
61+
where 35 should be replaced by the Python 3, you want to work this (e.g., `robotpkg-py36-eigenpy` to work with Python 3.6).
6262

6363
### Mac OS X
6464

6565
The installation of **EigenPy** on Mac OS X is made via [HomeBrew](https://brew.sh/).
66-
You just need to register the tap of the sofware repository.
66+
You just need to register the tap of the software repository.
6767

6868
```
6969
brew tap gepetto/homebrew-gepetto
@@ -83,8 +83,9 @@ The following people have been involved in the development of **EigenPy**:
8383
- [Sean Yen](https://www.linkedin.com/in/seanyentw) (Microsoft): Windows integration
8484
- [Loïc Estève](https://github.com/lesteve) (INRIA): Conda integration
8585
- [Wilson Jallet](https://manifoldfr.github.io/) (INRIA/LAAS-CNRS): core developer
86+
- [Joris Vaillant](https://github.com/jorisv) (Inria): core developer and manager of the project
8687

87-
If you have taken part to the development of **EigenPy**, feel free to add your name and contribution here.
88+
If you have taken part in the development of **EigenPy**, feel free to add your name and contribution here.
8889

8990
## Acknowledgments
9091

0 commit comments

Comments
 (0)