Skip to content

Commit

Permalink
Fix typos in README
Browse files Browse the repository at this point in the history
  • Loading branch information
itskalvik committed Aug 17, 2024
1 parent 16f3fc9 commit c0a0631
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The library includes python code for the following:
</p>

## Installation
The library is available as a ```pip``` package. To install the package, run the following command:
The library is available as a ```pip``` package. To install the package, run the following commands:

```
sudo apt-get install python3-pip libgdal-dev gdal-bin -y
Expand All @@ -36,7 +36,7 @@ python3 -m pip install -e .
Note: The requirements.txt file contains packages and their latest versions that were verified to be working without any issues.

## Quick Start
Please refer to the [examples](https://github.com/itskalvik/sgp-tools/tree/master/examples) folder for Jupyter notebooks demonstrating all the methods included in the library :smile:
Please refer to the [examples](https://github.com/itskalvik/sgp-tools/tree/main/examples) folder for Jupyter notebooks demonstrating all the methods included in the library :smile:

## Method Summary
[![Video Summary](https://res.cloudinary.com/marcomontalbano/image/upload/v1713536416/video_to_markdown/images/youtube--G-RKFa1vNHM-c05b58ac6eb4c4700831b2b3070cd403.jpg)](https://www.youtube.com/embed/G-RKFa1vNHM?si=PLmrmkCwXRj7mc4A "Video Summary")
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The library includes python code for the following:
<p align="center"><img src="assets/point_sensing.gif"><img src="assets/non-point_sensing.gif"></p>

## Installation
The library is available as a ```pip``` package. To install the package, run the following command:
The library is available as a ```pip``` package. To install the package, run the following commands:

```
sudo apt-get install python3-pip libgdal-dev gdal-bin -y
Expand All @@ -31,7 +31,7 @@ python3 -m pip install -e .
Note: The requirements.txt file contains packages and their latest versions that were verified to be working without any issues.

## Quick Start
Please refer to the [examples](https://github.com/itskalvik/sgp-tools/tree/master/examples) folder for Jupyter notebooks demonstrating all the methods included in the library 😄
Please refer to the [examples](https://github.com/itskalvik/sgp-tools/tree/main/examples) folder for Jupyter notebooks demonstrating all the methods included in the library 😄

## Method Summary
<p align="center"><div class="video-con"><iframe width="560" height="315" src="https://www.youtube.com/embed/G-RKFa1vNHM?si=PLmrmkCwXRj7mc4A" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></div></p>
Expand Down

0 comments on commit c0a0631

Please sign in to comment.