Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
furacca authored Mar 9, 2022
1 parent 9d8b61c commit b031cee
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,33 @@
# Cuterle
Bioinformatic tool which extract every domain annotated by InterProScan

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
| __ _____ _____ ____ _____ / \\
| / \ | | | | | \ | | / \\
| | | | | |__ |___/ | |__ / _ _ _ _ \\
| | | | | | |\ | | \ \\
| \__/ \__/ | |____ | \ |___ |____ \ \\
|_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _\ _ _ _ _ _\\
![](./screenshots/main_home.png)

## Getting started

### Prerequisites

- Python
- pip

### Installation

Install the required Python packages; while you are in the project's root directory run the following command:

```bash
# Install requirements
pip install -r requirements.txt
```

### Usage

In terminal, run the following command. By default, this will only retrieve Bulbasaur.

```bash
# Run the Serebii.net scraper
python scraper.py
```

Some useful commands are listed below.

```bash

0 comments on commit b031cee

Please sign in to comment.