Skip to content

Commit

Permalink
Release 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mgeier committed Sep 22, 2015
1 parent 254f091 commit 7c2021a
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ __pycache__/
build/
dist/
.eggs/
SoundFieldSynthesis.egg-info/
sfs.egg-info/
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2014 SFS Toolbox Developers
Copyright (c) 2014-2015 SFS Toolbox Developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
8 changes: 8 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
include LICENSE
include *.rst
include doc/requirements.txt
recursive-include doc *.rst *.py
recursive-include tests *.py
recursive-include examples *.py
include examples/figures/*.png
recursive-include data *
21 changes: 18 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Documentation:
Code:
http://github.com/sfstoolbox/sfs-python/

Python Package Index:
http://pypi.python.org/pypi/sfs/

Requirements
------------

Expand All @@ -31,14 +34,26 @@ distribution that already includes everything, e.g. Anaconda_.
Installation
------------

Currently, the package is not yet available on PyPI_ (but coming soon!), for
now you should get it from Github_::
Once you have installed the above-mentioned dependencies, you can use pip_
to download and install the latest release with a single command::

pip install sfs --user

If you want to install it system-wide for all users (assuming you have the
necessary rights), you can just drop the ``--user`` option.

To un-install, use::

pip uninstall sfs

If you want to keep up with the latest and greatest development version you
should get it from Github_::

git clone https://github.com/sfstoolbox/sfs-python.git
cd sfs-python
python setup.py develop --user

.. _PyPI: http://pypi.python.org/
.. _pip: http://www.pip-installer.org/en/latest/installing.html
.. _Github: http://github.com/sfstoolbox/sfs-python/

How to Get Started
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def run_tests(self):
exec(open('sfs/_version.py').read()) # "import" __version__

setup(
name="SoundFieldSynthesis",
name="sfs",
version=__version__,
packages=['sfs'],
install_requires=[
Expand All @@ -40,7 +40,7 @@ def run_tests(self):
long_description=open('README.rst').read(),
license="MIT",
keywords="audio SFS WFS Ambisonics".split(),
url="http://github.com/sfstoolbox",
url="http://github.com/sfstoolbox/",
platforms='any',
classifiers=[
"Development Status :: 3 - Alpha",
Expand Down
2 changes: 1 addition & 1 deletion sfs/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
"""

__version__ = "0.0.0"
__version__ = "0.1.0"

0 comments on commit 7c2021a

Please sign in to comment.