Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 3.44 KB

README.md

File metadata and controls

83 lines (50 loc) · 3.44 KB
Raw

Butter

Allow any computer user to watch movies easily streaming from torrents, without any particular knowledge.

Visit the project's website at https://butterproject.org.

Getting Involved

Want to report a bug, request a feature, contribute or translate Butter? Check out our in-depth guide to Contributing to Butter. We need all the help we can get! You can also join in with our community to keep up-to-date and meet other Butterrs.

Getting Started

If you're comfortable getting up and running from a git clone, this method is for you.

If you clone the GitHub repository, you will need to build a number of assets using grunt.

The master branch which contains the latest release.

Quickstart:

  1. npm install -g grunt-cli bower
  2. npm install
  3. grunt build
  4. grunt start

If you encounter trouble with the above method, you can try:

  1. npm install -g bower grunt-cli (Linux: you may need to run with sudo)
  2. cd desktop
  3. npm install
  4. bower install
  5. grunt lang
  6. grunt nodewebkit
  7. grunt css
  8. grunt start

Optionally, you may simply run ./make_butter.sh if you are on a linux or mac based operating system.

Full instructions & troubleshooting tips can be found in the Contributing Guide

Community

Keep track of Butter development and community activity.

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Butter will be maintained according to the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>-<build>

Constructed with the following guidelines:

  • A new major release indicates a large change where backward compatibility is broken.
  • A new minor release indicates a normal change that maintains backward compatibility.
  • A new patch release indicates a bugfix or small change which does not affect compatibility.
  • A new build release indicates this is a pre-release of the version.

If you distribute a copy or make a fork of the project, you have to credit this project as the source.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/ .

Copyright (c) 2015 Butter Project - Released under the GPL v3 license.