Skip to content

Commit

Permalink
Update README.md and setup.py for v0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
biqqles committed Jun 18, 2020
1 parent 2ac16c6 commit 894034a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,24 @@ Taken together, this yields a simple yet powerful API that can be used to explor
flint specifically supports vanilla Freelancer and [Discovery Freelancer](https://discoverygc.com), but in principle should work with any mod.

## Installation
flint is on PyPI:
Install the latest stable version from [PyPI](https://pypi.org/project/fl-flint) with pip:

```
python -m pip install fl-flint
pip install fl-flint
```

Alternatively you can install straight from this repository:
Or install the latest development version straight from this repository:

```sh
python -m pip install https://github.com/biqqles/flint/archive/master.zip
pip install https://github.com/biqqles/flint/archive/master.zip -U
```

Built wheels are also available under [Releases](https://github.com/biqqles/flint/releases), as is a changelog.

flint requires Python >= 3.6 because it uses the `dataclasses` module which was added in that release.
flint requires Python >= 3.6.

## Interactive shell
flint incorporates an interactive mode that can be used for testing or exploration. It provides a Python interpreter where flint is imported `as fl` and ready to use. To use it, run `python -m flint.interactive <path_to_freelancer>`. This mode will be used in the following examples.
flint incorporates an interactive mode that can be used for testing or exploration. It provides a Python interpreter where flint is imported `as fl` and ready to use. To use it, run `python -m flint <path_to_freelancer>`. This mode will be used in the following examples.

## API description
The API is unstable until v1.0. Minor details may change.
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

setup(
name='fl-flint', # distribution name
version='0.3',
version='0.4',

author='biqqles',
author_email='[email protected]',
Expand All @@ -19,7 +19,7 @@
long_description=open('README.md').read(),
long_description_content_type='text/markdown',

packages=find_packages() + ['flint.interactive'],
packages=find_packages(),
classifiers=[
'Programming Language :: Python :: 3',
'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
Expand Down

0 comments on commit 894034a

Please sign in to comment.