Skip to content

Commit

Permalink
MAINT update README
Browse files Browse the repository at this point in the history
  • Loading branch information
glemaitre committed Dec 17, 2017
1 parent ac0ce22 commit 2c5360b
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 20 deletions.
38 changes: 23 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,37 @@
Scikit-cycling
==============

[![Code Health](https://landscape.io/github/glemaitre/scikit-cycling/master/landscape.svg?style=flat)](https://landscape.io/github/glemaitre/scikit-cycling/master) [![codecov](https://codecov.io/gh/glemaitre/scikit-cycling/branch/master/graph/badge.svg)](https://codecov.io/gh/glemaitre/scikit-cycling) [![Build Status](https://travis-ci.org/glemaitre/scikit-cycling.svg?branch=master)](https://travis-ci.org/glemaitre/scikit-cycling) [![Build status](https://ci.appveyor.com/api/projects/status/3o28wvxsjljv8w97?svg=true)](https://ci.appveyor.com/project/glemaitre/scikit-cycling)
.. image:: https://travis-ci.org/scikit-cycling/scikit-cycling.svg?branch=master
:target: https://travis-ci.org/scikit-cycling/scikit-cycling

Goal
----

This toolbox will aggregate some useful tools to read into power data acquired by cyclists.
.. image:: https://readthedocs.org/projects/scikit-cycling/badge/?version=latest
:target: http://scikit-cycling.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

Installation
------------

### Dependencies
Dependencies
~~~~~~~~~~~~

Scikit-cycling requires:

This package needs the following dependencies:
* scipy
* numpy
* six
* fit-parse
* joblib

* Numpy,
* Scipy.

### Cloning
Installation
~~~~~~~~~~~~

You can install the package by cloning the source::

You can clone this repository with the usual `git clone`.
git clone https://github.com/scikit-cycling/scikit-cycling.git
cd scikit-cycling
pip install .

### Installation
This is also possible to directly install through pip::

```
pip install .
```
pip install git+https://github.com/scikit-cycling/scikit-cycling.git
6 changes: 3 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -301,8 +301,8 @@

# Config for sphinx_issues

issues_uri = 'https://github.com/glemaitre/scikit-cycling/issues/{issue}'
issues_github_path = 'glemaitre/scikit-cycling'
issues_uri = 'https://github.com/scikit-cycling/scikit-cycling/issues/{issue}'
issues_github_path = 'scikit-cycling/scikit-cycling'
issues_user_uri = 'https://github.com/{user}'


Expand All @@ -325,6 +325,6 @@ def setup(app):

# The following is used by sphinx.ext.linkcode to provide links to github
linkcode_resolve = make_linkcode_resolve('skcycling',
u'https://github.com/glemaitre/'
u'https://github.com/scikit-cycling/'
'scikit-cycling/blob/{revision}/'
'{package}/{path}#L{lineno}')
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
LONG_DESCRIPTION = f.read()
MAINTAINER = 'G. Lemaitre'
MAINTAINER_EMAIL = 'g.lemaitre58@gmail.com'
URL = 'https://github.com/glemaitre/scikit-cycling'
URL = 'https://github.com/scikit-cycling/scikit-cycling'
LICENSE = 'MIT'
DOWNLOAD_URL = 'https://github.com/glemaitre/scikit-cycling'
DOWNLOAD_URL = 'https://github.com/scikit-cycling/scikit-cycling'
VERSION = __version__
INSTALL_REQUIRES = ['numpy', 'scipy', 'six', 'joblib', 'fitparse']
CLASSIFIERS = ['Intended Audience :: Science/Research',
Expand Down

0 comments on commit 2c5360b

Please sign in to comment.