Skip to content

Commit

Permalink
docs: Update the readme with update code
Browse files Browse the repository at this point in the history
  • Loading branch information
KitsuneSemCalda committed Aug 26, 2024
1 parent ff73a34 commit 7d4847d
Showing 1 changed file with 18 additions and 41 deletions.
59 changes: 18 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,60 +15,35 @@ Animatic is a Go-based application designed to search and watch anime episodes f

- Downloads all episodes of the selected anime.

- Use --gac to salve the content in same directory from [go-anime](https://github.com/alvarorichard/GoAnime)

- Provides error messages for various failure cases such as lack of internet connection, failure to locate the anime, and inability to access episode URLs.

>[!CAUTION]
> Doesn't make pos-install with this script (don't work) or run this script in root mode
## How Install

## Fast Installation
To fast install this project do you need run the script: "install.sh" with sudo
1. Start compiling the animatic-v2 with

```bash
bash install.sh
go build cmd/animatic-v2/main.go
```

>[!WARNING]
> Fast install works only linux
## How to use

>[!CAUTION]
> Do you need go 1.21.5 installed in your system
2. Move the animatic-v2 from $HOME/.local/bin/

Create a directory chromeMedia in root:
```bash
sudo mkdir /chromeMedia
mv main $HOME/.local/bin/animatic-v2
```

If chromeMedia is a root owned directory, you need change owner to your user
```bash
sudo chown $USER /chromeMedia
```
> [!TIP]
> The animatic-v2 pass by refactoring and doesn't has a default directory from download the files
> We can use go-anime base to salve content and mpv to reproduce automatically alread downloaded files
> Is recomended adding this alias in your default shell dotfile
Compile the project in your enviroment:
```bash
go build
alias animatic="animatic-v2 --gac --debug"
```

Setting Path to new local:
```bash
export PATH=$PATH:~/.local/bin
```

Move the project from some directory in your path
```bash
mv animatic-v2 ~/.local/bin/animatic
```

## Running:

Run in your shell:

```bash
animatic
```

The code open the prompt-ui label to you write the anime name to be downloaded.
- The flag `--gac` uses the go-anime default directory from save the animes
- The flag `--debug` show the information about the download process

## Contributing

Expand All @@ -80,5 +55,7 @@ Contributions are what make the open-source community such an amazing place to l
4. Push to the Branch
5. Open a Pull Request

>[!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
### TODO

- [ ] Adding a fallback using another website
- [ ] Make blogger download videos working properly

0 comments on commit 7d4847d

Please sign in to comment.