Skip to content

Commit 7d680dc

Browse files
committed
simplify readme with badges, add installation comments about conda-forge
1 parent 5de798b commit 7d680dc

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.rst

+8-15
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@
66
.. image:: https://codecov.io/gh/pmorissette/bt/branch/master/graph/badge.svg
77
:target: https://codecov.io/pmorissette/bt
88

9+
.. image:: https://img.shields.io/pypi/v/bt
10+
:alt: PyPI
11+
:target: https://pypi.org/project/bt/
12+
13+
.. image:: https://img.shields.io/pypi/l/bt
14+
:alt: PyPI - License
15+
:target: https://pypi.org/project/bt/
16+
917
bt - Flexible Backtesting for Python
1018
====================================
1119

@@ -112,18 +120,3 @@ This environment allows you to plot your charts in-line and also allows you to
112120
easily add surrounding text with Markdown. You can easily create Notebooks that
113121
you can share with colleagues and you can also save them as PDFs. If you are not
114122
yet convinced, head over to their website.
115-
116-
Special Thanks
117-
--------------
118-
119-
A special thanks to the following contributors for their involvement with the project:
120-
121-
* Vladimir Filimonov `@vfilimonov <https://github.com/vfilimonov>`_
122-
* Jordan Platts `@JordanPlatts <https://github.com/JordanPlatts>`_
123-
* Pascal Tomecek `@ptomecek <https://github.com/ptomecek>`_
124-
125-
126-
License
127-
-------
128-
129-
MIT

docs/source/install.rst

+10-3
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,25 @@ Installing bt
55
-------------
66

77
The easiest way to install ``bt`` is from the `Python Package Index <https://pypi.python.org/pypi/bt/>`_
8-
using ``pip`` or ``easy_insatll``:
8+
using ``pip``:
99

1010
.. code-block:: bash
1111
1212
$ pip install bt
1313
14-
Since bt has many dependencies, we strongly recommend installing the `Anaconda Scientific Python
14+
Since ``bt`` has many dependencies, we strongly recommend installing the `Anaconda Scientific Python
1515
Distribution <https://store.continuum.io/cshop/anaconda/>`_, especially on Windows. This distribution
1616
comes with many of the required packages pre-installed, including pip. Once Anaconda is installed, the above
1717
command should complete the installation.
1818

19-
bt should be compatible with Python 2.7.
19+
``bt`` is also available on `Conda Forge <https://conda-forge.org/>`_, and installable via:
20+
21+
.. code-block:: bash
22+
23+
$ conda install bt --channel conda-forge
24+
25+
26+
``bt`` is compatible with Python >=3.7.
2027

2128
Recommended Setup
2229
-----------------

0 commit comments

Comments
 (0)