Skip to content

Commit

Permalink
Fix #43: Update Readme with badges & contributing guidelines (#48)
Browse files Browse the repository at this point in the history
* Update Readme

* Add EvalAI-CLI heading

* Add review comments
  • Loading branch information
RishabhJain2018 authored Jun 22, 2018
1 parent 9719a9f commit 8899194
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 10 deletions.
37 changes: 27 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,50 @@
# EvalAI CLI
# EvalAI-CLI

Official Command Line utility to use EvalAI in your terminal.
Official Command Line utility to use EvalAI in your terminal.

This package offers almost all of the full suite of features available on the website within your terminal.
------------------------------------------------------------------------------------------

[![Join the chat at https://gitter.im/Cloud-CV/EvalAI](https://badges.gitter.im/Cloud-CV/EvalAI.svg)](https://gitter.im/Cloud-CV/EvalAI?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://travis-ci.org/Cloud-CV/evalai-cli.svg?branch=master)](https://travis-ci.org/Cloud-CV/evalai-cli)
[![Coverage Status](https://coveralls.io/repos/github/Cloud-CV/evalai-cli/badge.svg?branch=master)](https://coveralls.io/github/Cloud-CV/evalai-cli?branch=master)

## Goal

The goal of this package is to offer almost all the features available on the website within your terminal.

## Development Setup

1. Clone the repository to your machine
### Step 1:

Setup the development environment for EvalAI and make sure that django server & submission worker is running perfectly

### Step 2:

1. Clone the evalai-cli repository to your machine via git

```bash
git clone https://github.com/Cloud-CV/evalai-cli.git EvalAI-CLI
```

2. Setup the virtual environment.
2. Create a virtual environment

```bash
$ cd EvalAI-CLI
$ virtualenv -v python3 venv
$ source venv/bin/activate
```
3. Install the dependencies.
3. Install the package dependencies

```bash
$ pip install -r requirements.txt
```


2. Install the package locally to try it out.
4. Install the package locally to try it out

```bash
$ pip install -e .
```
$ pip install -e .
```

## Contributing Guidelines

If you are interested in contributing to EvalAI-CLI, follow our [contribution guidelines](https://github.com/Cloud-CV/evalai-cli/blob/master/.github/CONTRIBUTING.md).
Binary file added docs/static/images/evalai_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/images/kaggle_comparison.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8899194

Please sign in to comment.