Skip to content

Commit

Permalink
Merge pull request #38 from ayrna/development
Browse files Browse the repository at this point in the history
README update
  • Loading branch information
franberchez authored Jan 18, 2024
2 parents a05ee6e + ec53b9c commit cb89089
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,16 @@ The library includes various modules such as loss functions, models, layers, met
| Overview | |
|-----------|------------------------------------------------------------------------------------------------------------------------------------------|
| **CI/CD** | [![!codecov](https://img.shields.io/codecov/c/github/ayrna/dlordinal?label=codecov&logo=codecov)](https://codecov.io/gh/ayrna/dlordinal) [![!docs](https://readthedocs.org/projects/dlordinal/badge/?version=latest&style=flat)](https://dlordinal.readthedocs.io/en/latest/) [![!python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue)](https://www.python.org/) |
| **Code** | [![![binder]](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ayrna/dlordinal/main?filepath=tutorials) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Linter: Ruff](https://img.shields.io/badge/Linter-Ruff-brightgreen?style=flat-square)](https://github.com/charliermarsh/ruff) |
| **Code** | [![![pypi]](https://img.shields.io/pypi/v/dlordinal)](https://pypi.org/project/dlordinal/1.0.1/) [![![binder]](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ayrna/dlordinal/main?filepath=tutorials) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Linter: Ruff](https://img.shields.io/badge/Linter-Ruff-brightgreen?style=flat-square)](https://github.com/charliermarsh/ruff) |

## ⚙️ Installation

You can install **dlordinal** directly from the GitHub repository using the following command in your terminal:
`dlordinal v1.0.1` is the last version supported by Python 3.8, Python 3.9 and Python 3.10.

pip install git+https://github.com/ayrna/dlordinal.git@main
The easiest way to install `dlordinal` is via `pip`:

Also, you can clone the repository and then install the library from the local repository folder:
pip install dlordinal

git clone git@github.com:ayrna/dlordinal.git
pip install ./dlordinal

## Collaborating

Expand All @@ -28,6 +26,13 @@ Please, contact the maintainers (maybe opening an issue) before doing any work t

### Guidelines for code contributions

* You can clone the repository and then install the library from the local repository folder:

```bash
git clone git@github.com:ayrna/dlordinal.git
pip install ./dlordinal
```

* In order to set up the environment for development, install the project in editable mode and include the optional dev requirements:
```bash
pip install -e '.[dev]'
Expand Down

0 comments on commit cb89089

Please sign in to comment.