Skip to content

Commit 7c2021a

Browse files
committed
Release 0.1.0
1 parent 254f091 commit 7c2021a

File tree

6 files changed

+31
-8
lines changed

6 files changed

+31
-8
lines changed

Diff for: .gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ __pycache__/
33
build/
44
dist/
55
.eggs/
6-
SoundFieldSynthesis.egg-info/
6+
sfs.egg-info/

Diff for: LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2014 SFS Toolbox Developers
1+
Copyright (c) 2014-2015 SFS Toolbox Developers
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy
44
of this software and associated documentation files (the "Software"), to deal

Diff for: MANIFEST.in

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
include LICENSE
2+
include *.rst
3+
include doc/requirements.txt
4+
recursive-include doc *.rst *.py
5+
recursive-include tests *.py
6+
recursive-include examples *.py
7+
include examples/figures/*.png
8+
recursive-include data *

Diff for: README.rst

+18-3
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Documentation:
1111
Code:
1212
http://github.com/sfstoolbox/sfs-python/
1313

14+
Python Package Index:
15+
http://pypi.python.org/pypi/sfs/
16+
1417
Requirements
1518
------------
1619

@@ -31,14 +34,26 @@ distribution that already includes everything, e.g. Anaconda_.
3134
Installation
3235
------------
3336

34-
Currently, the package is not yet available on PyPI_ (but coming soon!), for
35-
now you should get it from Github_::
37+
Once you have installed the above-mentioned dependencies, you can use pip_
38+
to download and install the latest release with a single command::
39+
40+
pip install sfs --user
41+
42+
If you want to install it system-wide for all users (assuming you have the
43+
necessary rights), you can just drop the ``--user`` option.
44+
45+
To un-install, use::
46+
47+
pip uninstall sfs
48+
49+
If you want to keep up with the latest and greatest development version you
50+
should get it from Github_::
3651

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

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

4459
How to Get Started

Diff for: setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def run_tests(self):
2626
exec(open('sfs/_version.py').read()) # "import" __version__
2727

2828
setup(
29-
name="SoundFieldSynthesis",
29+
name="sfs",
3030
version=__version__,
3131
packages=['sfs'],
3232
install_requires=[
@@ -40,7 +40,7 @@ def run_tests(self):
4040
long_description=open('README.rst').read(),
4141
license="MIT",
4242
keywords="audio SFS WFS Ambisonics".split(),
43-
url="http://github.com/sfstoolbox",
43+
url="http://github.com/sfstoolbox/",
4444
platforms='any',
4545
classifiers=[
4646
"Development Status :: 3 - Alpha",

Diff for: sfs/_version.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
1010
"""
1111

12-
__version__ = "0.0.0"
12+
__version__ = "0.1.0"

0 commit comments

Comments
 (0)