Skip to content

Commit

Permalink
Various fixes for PyPY, README, and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
matteosantama committed Apr 13, 2023
1 parent 634d71c commit 1415325
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ All of the above checks are run in the CI.

## Documentation

To build and serve the documentation locally, run
By default, `$ poetry install` will not install the necessary documentation dependenices. If you wish to build and
serve the documentation locally, first run `$ poetry install --with docs` to and then

```shell
$ sphinx-autobuild docs/source docs/build
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
<h1 align="center">MFGLib: A Library for Mean-Field Games</h1>

<p align="center">
<a href='https://mfglib.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/mfglib/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="http://mypy-lang.org/"><img alt="Checked with mypy" src="http://www.mypy-lang.org/static/mypy_badge.svg"></a>
<a href="https://github.com/charliermarsh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json&label=linting" alt="Ruff" style="max-width:100%;"></a>
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<a href="https://pycqa.github.io/isort/"><img alt="Imports: isort" src="https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336"></a>
<a href="https://opensource.org/licenses/MIT"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-purple.svg"></a>
Expand All @@ -13,6 +17,14 @@ for the community to easily prototype and implement new algorithms and environme

The official documentation for MFGLib is available at https://mfglib.readthedocs.io/en/latest/.

## Installation

MFGLib supports all major platforms and can be installed with `pip`:

```
$ pip install mfglib
```

## Citing
If you wish to cite `MFGLib`, please use the following:
```
Expand Down
4 changes: 3 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "mfglib"
version = "0.1.0"
version = "0.1.1"
description = "A Library for Mean-Field Games"
authors = [
"Xin Guo <xinguo@berkeley.edu>",
Expand All @@ -10,6 +10,8 @@ authors = [
"Junzi Zhang <saslascroyale@gmail.com>",
]
readme = "README.md"
license = "MIT"
documentation = "https://mfglib.readthedocs.io/en/latest/"

[tool.poetry.dependencies]
python = "^3.8"
Expand Down

0 comments on commit 1415325

Please sign in to comment.