126b807dc7
I am making changes here to help the README be consistent in its styling and gramatically correct. Specifically distro vs distribution and places where there are no links where they would be useful. * Add link to GitHub Issues * Add link to EVE pyfa forum thread * Rename Installing to Installation * Change distros to distributions * Add apostrophe to "projects" where it is posessive
pyfa
What is it?
pyfa, short for python fitting assistant, allows you to create, experiment with, and save ship fittings without being in game. Open source and written in Python, it is available on any platform where Python 2.x and wxWidgets are available, including Windows, Mac OS X, and Linux.
Latest Version and Changelogs
The latest version along with release notes can always be found on the project's Releases page. pyfa will notify you if you are running an outdated version.
Installation
Windows and OS X users are supplied self-contained builds of pyfa on the latest releases page. An .exe installer is also available for Windows builds. Linux users can run pyfa using their distribution's Python interpreter. There is no official self-contained package for Linux, however, there are a number of third-party packages available through distribution-specific repositories.
Linux Distro-specific Packages
The following is a list of pyfa packages available for certain distributions. Please note that these packages are maintained by third-parties and are not evaluated by the pyfa developers.
- Debian/Ubuntu/derivitives: https://github.com/AdamMajer/Pyfa/releases
- Arch: https://aur.archlinux.org/packages/pyfa/
- openSUSE: https://build.opensuse.org/package/show/home:rmk2/pyfa
- FreeBSD: http://www.freshports.org/games/pyfa/ (see #484 for instructions)
Dependencies
If you wish to help with development or simply need to run pyfa through a Python interpreter, the following software is required:
- Python 2.7
wxPython2.8/3.0sqlalchemy>= 0.6dateutilmatplotlib(for some Linux distributions you may need to install separate wxPython bindings such aspython-matplotlib-wx)requests
Bug Reporting
The preferred method of reporting bugs is through the project's GitHub Issues interface. Alternatively, posting a report in the pyfa thread on the official EVE Online forums is acceptable. Guidelines for bug reporting can be found on this wiki page.
License
pyfa is licensed under the GNU GPL v3.0, see LICENSE
Resources
- Development repository: http://github.com/DarkFenX/Pyfa
- XMPP conference: pyfa@conference.jabber.org
- EVE forum thread
- EVE University guide using pyfa
- EVE Online website
Contacts:
- Sable Blitzmann
- GitHub: @blitzmann
- TweetFleet Slack: @blitzmann
- Gitter chat: @ blitzmann
- Email: sable.blitzmann@gmail.com
CCP Copyright Notice
EVE Online, the EVE logo, EVE and all associated logos and designs are the intellectual property of CCP hf. All artwork, screenshots, characters, vehicles, storylines, world facts or other recognizable features of the intellectual property relating to these trademarks are likewise the intellectual property of CCP hf. EVE Online and the EVE logo are the registered trademarks of CCP hf. All rights are reserved worldwide. All other trademarks are the property of their respective owners. CCP hf. has granted permission to Osmium to use EVE Online and all associated logos and designs for promotional and information purposes on its website but does not endorse, and is not in any way affiliated with, Osmium. CCP is in no way responsible for the content on or functioning of this website, nor can it be liable for any damage arising from the use of this website.