-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md with logo, project description and installation inst…
…ructions
- Loading branch information
1 parent
f53bf7d
commit 2f77ec9
Showing
1 changed file
with
27 additions
and
47 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 |
|---|---|---|
| @@ -1,104 +1,84 @@ | ||
| # Animatic-v2 | ||
| <p align="center"> | ||
| <img src="https://github.com/VitorCarvalho67/faster-news/assets/102667323/4652d5ad-0ce4-4282-8112-9c9c6137b551" /> | ||
| </p> | ||
|
|
||
| ## Description | ||
| # Animatic - V.02 | ||
| [](KitsuneSemCalda/Animatic-v2/blob/master/LICENSE)      | ||
|
|
||
| Animatic-v2 is a Go-based application designed to search and download anime episodes from the web. It provides a command-line interface for users to input the name of the anime they wish to download. | ||
|
|
||
| >[!CAUTION] | ||
| > Doesn't make pos-install with this script (don't work) or run this script in root mode | ||
| >[!WARNING] | ||
| > Fast install works only linux | ||
| >[!WARNING] | ||
| > We have a bug in bubbletea with lipgloss, the terminal cursor is hiding and doesn't appears anymore, if you have some solution and want contributing is appreciate | ||
| Animatic is a Go-based application designed to search and watch anime episodes from the web, as well as to provide the option to download them. It offers a command-line interface for users to input the name of the anime they wish to access or download. The project is particularly geared towards those who prefer interacting with the application through the terminal, making it a streamlined and efficient way to search for and view anime episodes for enthusiasts of the genre. Its main focus is on anime content with **Portuguese** dubbing and subtitles. | ||
|
|
||
| ## Features | ||
|
|
||
| - Checks for internet connection at startup. | ||
|
|
||
| - Searches for the requested anime on AnimeFire. | ||
|
|
||
| - Downloads all episodes of the selected anime. | ||
|
|
||
| - Provides error messages for various failure cases such as lack of internet connection, failure to locate the anime, and inability to access episode URLs. | ||
|
|
||
| ## Fast Installation | ||
| >[!CAUTION] | ||
| > Doesn't make pos-install with this script (don't work) or run this script in root mode | ||
| ## Fast Installation | ||
| To fast install this project do you need run the script: "install.sh" with sudo | ||
|
|
||
| ```bash | ||
| bash install.sh | ||
| ``` | ||
|
|
||
| ## Installation | ||
| >[!WARNING] | ||
| > Fast install works only linux | ||
| ## How to use | ||
|
|
||
| >[!CAUTION] | ||
| > Do you need go 1.21.5 installed in your system | ||
| To install this project we need follow this steps: | ||
|
|
||
| - Create a directory chromeMedia in root: | ||
|
|
||
| Create a directory chromeMedia in root: | ||
| ```bash | ||
| sudo mkdir /chromeMedia | ||
| ``` | ||
|
|
||
| If chromeMedia is a root owned directory, you need change owner to your user | ||
|
|
||
| ```bash | ||
| sudo chown $USER /chromeMedia | ||
| ``` | ||
|
|
||
| - Compile the project in your enviroment: | ||
|
|
||
| Compile the project in your enviroment: | ||
| ```bash | ||
| go build | ||
| ``` | ||
|
|
||
| - Setting Path to new local: | ||
|
|
||
| Setting Path to new local: | ||
| ```bash | ||
| export PATH=$PATH:~/.local/bin | ||
| ``` | ||
|
|
||
| - Move the project from some directory in your path | ||
|
|
||
| Move the project from some directory in your path | ||
| ```bash | ||
| mv animatic-v2 ~/.local/bin/animatic | ||
| ``` | ||
|
|
||
| - Re-open your shell | ||
| ## Running: | ||
|
|
||
| ## Usage | ||
|
|
||
| >[!NOTE] | ||
| > This script only download episodes to Plex/Jellyfin and playing the anime is your responsability. | ||
| >[!NOTE] | ||
| > The downloaded episodes is only pt-br subtitles and dub | ||
| To use this code is simple: | ||
|
|
||
| - Run in your shell: | ||
| Run in your shell: | ||
|
|
||
| ```bash | ||
| animatic | ||
| ``` | ||
|
|
||
| The code open the prompt-ui label to you write the anime name to be downloaded. | ||
|
|
||
| After write the name press enter and the code list animes with related names, use the arrow from select the anime and press enter. | ||
|
|
||
| Before this is await the download ending | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| 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`) | ||
| 2. Create your Feature Branch | ||
| 3. Commit your Changes | ||
| 4. Push to the Branch | ||
| 5. Open a Pull Request | ||
|
|
||
| ## License | ||
|
|
||
| Distributed under the [MIT License](https://github.com/KitsuneSemCalda/Animatic-v2/tree/master/LICENSE). | ||
| >[!WARNING] | ||
| > We have a bug in bubbletea with lipgloss, the terminal cursor is hiding and doesn't appears anymore, if you have some solution and want contributing is appreciate |