Project Title

Aeneas GUI

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Dependencies required

Runtime

aeneas core along with all required python dependencies
ffmpeg
espeak
youtube-dl python module (optional)

Build Time

node.js
electron
bower
polymer(global modules)
other node.js modules

Installing

Node.js is required to be installed locally only while building the application

Install node.js and polymer-cli

sudo npm install -g polymer-cli

Bower

sudo npm install -g bower
bower install
mv bower_components lib

It is important to rename the bower_components folder as then we can save space in the final package

Build final package

./make --windows
./make --osx
./make

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

Polymer - The web framework library used
electron - The cross-platform desktop application the application runs on
AppImage - For building the linux binary appImage

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use git for versioning. For the versions available, see the tags on this repository.

Authors

Chetan Chauhan - Initial work - chetan-prime
Michele Gianella - Project Designer See also the list of contributors who participated in this project.

License

This project is licensed under the AGPL License - see the LICENSE.md file for details

Acknowledgments

Hat tip to anyone who's code was used
Inspiration
etc

chetan-prime/aeneas-gui