-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
58 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,9 +10,6 @@ | |
| [![Forks][forks-shield]][forks-url] | ||
| [![Stargazers][stars-shield]][stars-url] | ||
| [![Issues][issues-shield]][issues-url] | ||
| [![MIT License][license-shield]][license-url] | ||
| [![LinkedIn][linkedin-shield]][linkedin-url] | ||
|
|
||
|
|
||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
|
|
@@ -59,120 +56,110 @@ | |
| <!-- ABOUT THE PROJECT --> | ||
| ## About The Project | ||
|
|
||
| [![Product Name Screen Shot][product-screenshot]](https://raw.githubusercontent.com/Pataclop/Movinyl/master/example_img/3.jpg) | ||
|
|
||
| There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need. | ||
|
|
||
| Here's why: | ||
| * Your time should be focused on creating something amazing. A project that solves a problem and helps others | ||
| * You shouldn't be doing the same tasks over and over like creating a README from scratch | ||
| * You should element DRY principles to the rest of your life :smile: | ||
| Movinyl is a fun visualization project to capture the colors and spirit of a movie through beautiful posters featuring the frames of a movie in a vibrant, vinyl-like disk. | ||
|
|
||
| Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. | ||
| Take a look at what we're talking about | ||
|
|
||
|  | ||
|
|
||
| A list of commonly used resources that I find helpful are listed in the acknowledgements. | ||
|
|
||
| ### Built With | ||
| This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. | ||
| * [Bootstrap](https://getbootstrap.com) | ||
| * [JQuery](https://jquery.com) | ||
| * [Laravel](https://laravel.com) | ||
|
|
||
|
|
||
| * [Pymdb](https://github.com/dannyarcher/pymdb) | ||
| * C++ and Python | ||
| * OpenMP (coming soon!) | ||
|
|
||
| <!-- GETTING STARTED --> | ||
| ## Getting Started | ||
|
|
||
| This is an example of how you may give instructions on setting up your project locally. | ||
| To get a local copy up and running follow these simple example steps. | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| This is an example of how to list things you need to use the software and how to install them. | ||
| * npm | ||
| ```sh | ||
| npm install npm@latest -g | ||
| ``` | ||
| Everything required for the project is in the installation script within the repository. | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Get a free API Key at [https://example.com](https://example.com) | ||
| 2. Clone the repo | ||
|
|
||
| 1. Clone the repository | ||
| ```sh | ||
| git clone https:://github.com/your_username_/Project-Name.git | ||
| git clone https:://github.com/Pataclop/Movinyl.git | ||
| ``` | ||
| 3. Install NPM packages | ||
| 2. Run the project setup to install required libraries and compile the project | ||
| ```sh | ||
| npm install | ||
| ./0_Setup | ||
| ``` | ||
| 4. Enter your API in `config.js` | ||
| ```JS | ||
| const API_KEY = 'ENTER YOUR API'; | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| <!-- USAGE EXAMPLES --> | ||
| ## Usage | ||
|
|
||
| Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. | ||
| 3. Place your video files in the PROCESSING_ZONE folder | ||
| ```sh | ||
| cp ~/Videos/YOUR_VIDEO.mp4 ~/Movinyl/PROCESSING_ZONE/YOUR_VIDEO.mp4 | ||
| ``` | ||
| 4. Run the image generator script | ||
| ```sh | ||
| ./1_IMAGE_GENERATOR | ||
| ``` | ||
| 5. Cleanup with the video remover script | ||
| ```sh | ||
| ./2_VIDEO_REMOVER | ||
| ``` | ||
| 6. Run the disk creator script and wait for the image to be generated | ||
| ```sh | ||
| ./3_BATCH_LAUNCH | ||
| ``` | ||
| 7. Run the rename script to organize your folder and rename files | ||
| ```sh | ||
| ./4_RENAME_SAVE | ||
| ``` | ||
| 8. Replace the spaces and the parentheses in the names by underscores | ||
| ```./The Beach (2000)``` -> ```./The_Beach_2000``` | ||
|
|
||
| _For more examples, please refer to the [Documentation](https://example.com)_ | ||
| 9. (Optional) Run the color picker GUI to select 5 colors for the movie poster | ||
|
|
||
| ```sh | ||
| python3 run_interface.py | ||
| ``` | ||
| 10. Move the disk images to the root of the project | ||
|
|
||
| 11. Run the make page script for a single video or for multiple videos | ||
| ```sh | ||
| ./5_MAKE_PAGE -s movie_name r g b r g b r g b r g b r g b | ||
| ``` | ||
| or | ||
| ```sh | ||
| ./5_MAKE_PAGE -f info.txt | ||
| ``` | ||
|
|
||
| <!-- ROADMAP --> | ||
| ## Roadmap | ||
|
|
||
| See the [open issues](https://github.com/Pataclop/Movinyl/issues) for a list of proposed features (and known issues). | ||
|
|
||
| See the [open issues](https://github.com/Pataclop/Movinyl/issues) for a list of proposed features and known issues. Please feel free to add to our roadmap. | ||
|
|
||
| * Multithreading for disks.cpp | ||
| * Multithreading for pages.cpp | ||
| * Reduce the number of scripts and instructions to make the experience more seamless | ||
|
|
||
| <!-- CONTRIBUTING --> | ||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
| Any contributions you make are **greatly appreciated**. If you have any suggestions for our project or have coding experience and would like to join the project, please reach out to us! | ||
|
|
||
| For code contributions: | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 5. Open a Pull Request | ||
|
|
||
|
|
||
|
|
||
| <!-- LICENSE --> | ||
| ## License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE` for more information. | ||
|
|
||
|
|
||
| Coming Soon! | ||
|
|
||
| <!-- CONTACT --> | ||
| ## Contact | ||
|
|
||
| Your Name - [@your_twitter](https://twitter.com/your_username) - [email protected] | ||
|
|
||
| Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) | ||
|
|
||
|
|
||
|
|
||
| <!-- ACKNOWLEDGEMENTS --> | ||
| ## Acknowledgements | ||
| * [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet) | ||
| * [Img Shields](https://shields.io) | ||
| * [Choose an Open Source License](https://choosealicense.com) | ||
| * [GitHub Pages](https://pages.github.com) | ||
| * [Animate.css](https://daneden.github.io/animate.css) | ||
| * [Loaders.css](https://connoratherton.com/loaders) | ||
| * [Slick Carousel](https://kenwheeler.github.io/slick) | ||
| * [Smooth Scroll](https://github.com/cferdinandi/smooth-scroll) | ||
| * [Sticky Kit](http://leafo.net/sticky-kit) | ||
| * [JVectorMap](http://jvectormap.com) | ||
| * [Font Awesome](https://fontawesome.com) | ||
|
|
||
|
|
||
|
|
||
| Please shoot us a message at: [email protected] | ||
| Project Link: [https://github.com/Pataclop/Movinyl](https://github.com/Pataclop/Movinyl) | ||
|
|
||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
|
|
@@ -187,6 +174,3 @@ Project Link: [https://github.com/your_username/repo_name](https://github.com/yo | |
| [issues-url]: https://github.com/Pataclop/Movinyl/issues | ||
| [license-shield]: https://img.shields.io/github/license/Pataclop/Movinyl.svg?style=flat-square | ||
| [license-url]: https://github.com/Pataclop/Movinyl/blob/master/LICENSE.txt | ||
| [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 | ||
| [linkedin-url]: https://linkedin.com/in/Pataclop | ||
| [product-screenshot]: images/screenshot.png | ||