Skip to content

Latest commit

 

History

History
91 lines (52 loc) · 4.77 KB

README.md

File metadata and controls

91 lines (52 loc) · 4.77 KB
Raw

Butter

Build Status Dependency Status devDependency Status

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

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

WARNING : This project is in very early stage development and almost nothing works yet ! It will someday replace the current butter-desktop app based on others techs. This project is using Electron + Angular + Coffee. If you want to help and have any skills in one of these techs, please submit a PR and give Butter some love :-)

Screenshot of Butter app

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:

Note that in Ubuntu (or derivative system) you probably need to upgrade nodejs and npm version. To do so, run the following :

  1. curl -sL https://deb.nodesource.com/setup_0.12 | sudo bash -
  2. sudo apt-get --yes install nodejs && sudo npm -g install npm

Then you can start building Butter :

  1. npm install -g grunt-cli bower (Linux: you need to run with sudo)
  2. npm install ## Install local dependencies in node_modules/
  3. grunt build ## Build the Butter application
  4. grunt start ## Start the Butter application

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

You can also have a look at the Dockerfile as a build example.

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

Generate executable packages

You can generate executable packages for all platforms with grunt package. The packages are in dist/.

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.

License

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.