Skip to content

Commit 83fea36

Browse files
authored
docs: fix broken relative links in README for crates.io compatibility (#926)
Fixes #735 Relative links in `README.md` (e.g., to `docs/config.md` or `examples/README.md`) resolve incorrectly when the crate is viewed on [crates.io](https://crates.io/crates/spotify_player), leading to 404 errors. This PR replaces these relative links with absolute URLs pointing to the `master` branch on GitHub.
1 parent f7b4048 commit 83fea36

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
**Features**
2929

3030
- Minimalist UI with an intuitive paging and popup system.
31-
- Highly [configurable](docs/config.md)
31+
- Highly [configurable](https://github.com/aome510/spotify-player/blob/master/docs/config.md)
3232
- Feature parity with the official Spotify application.
3333
- Support remote control with [Spotify Connect](#spotify-connect).
3434
- Support [streaming](#streaming) songs directly from the terminal.
@@ -43,7 +43,7 @@
4343

4444
A demo of `spotify_player` `v0.5.0-pre-release` on [youtube](https://www.youtube.com/watch/Jbfe9GLNWbA) or on [asciicast](https://asciinema.org/a/446913):
4545

46-
Checkout [examples/README.md](./examples/README.md) for more examples.
46+
Checkout [examples/README.md](https://github.com/aome510/spotify-player/blob/master/examples/README.md) for more examples.
4747

4848
## Installation
4949

@@ -201,7 +201,7 @@ cargo install spotify_player --no-default-features
201201

202202
### Media Control
203203

204-
To enable media control support, `spotify_player` needs to be built/installed with `media-control` feature (**enabled** by default) and set the `enable_media_control` config option to `true` in the [general configuration file](docs/config.md#media-control).
204+
To enable media control support, `spotify_player` needs to be built/installed with `media-control` feature (**enabled** by default) and set the `enable_media_control` config option to `true` in the [general configuration file](https://github.com/aome510/spotify-player/blob/master/docs/config.md#media-control).
205205

206206
Media control support is implemented using [MPRIS DBus](https://wiki.archlinux.org/title/MPRIS) on Linux and OS window event listener on Windows and MacOS.
207207

@@ -403,7 +403,7 @@ List of supported commands:
403403
| `JumpToCurrentTrackInContext` | jump to the current track in the context | `g c` |
404404
| `JumpToHighlightTrackInContext` | jump to the currently highlighted search result in the context | `C-g` |
405405

406-
To add new shortcuts or modify the default shortcuts, please refer to the [keymaps section](docs/config.md#keymaps) in the configuration documentation.
406+
To add new shortcuts or modify the default shortcuts, please refer to the [keymaps section](https://github.com/aome510/spotify-player/blob/master/docs/config.md#keymaps) in the configuration documentation.
407407

408408
### Actions
409409

@@ -429,7 +429,7 @@ List of available actions:
429429
- `Follow`
430430
- `Unfollow`
431431

432-
These actions can also be bound to a shortcut. To add new shortcuts, please refer to the [actions section](docs/config.md#actions) in the configuration documentation.
432+
These actions can also be bound to a shortcut. To add new shortcuts, please refer to the [actions section](https://github.com/aome510/spotify-player/blob/master/docs/config.md#actions) in the configuration documentation.
433433

434434
### Search Page
435435

@@ -443,7 +443,7 @@ By default, `spotify_player` will look into `$HOME/.config/spotify-player` for a
443443

444444
If an application configuration file is not found, one will be created with default values.
445445

446-
Please refer to [the configuration documentation](docs/config.md) for more details on the configuration options.
446+
Please refer to [the configuration documentation](https://github.com/aome510/spotify-player/blob/master/docs/config.md) for more details on the configuration options.
447447

448448
## Caches
449449

@@ -457,4 +457,4 @@ The application stores logs inside the `$APP_CACHE_FOLDER/spotify-player-*.log`
457457

458458
## Acknowledgement
459459

460-
`spotify_player` is written in [Rust](https://www.rust-lang.org) and is built on top of awesome libraries such as [ratatui](https://github.com/ratatui/ratatui), [rspotify](https://github.com/ramsayleung/rspotify), [librespot](https://github.com/librespot-org/librespot), and [many more](spotify_player/Cargo.toml). It's highly inspired by [spotify-tui](https://github.com/Rigellute/spotify-tui) and [ncspot](https://github.com/hrkfdn/ncspot).
460+
`spotify_player` is written in [Rust](https://www.rust-lang.org) and is built on top of awesome libraries such as [ratatui](https://github.com/ratatui/ratatui), [rspotify](https://github.com/ramsayleung/rspotify), [librespot](https://github.com/librespot-org/librespot), and [many more](https://github.com/aome510/spotify-player/blob/master/spotify_player/Cargo.toml). It's highly inspired by [spotify-tui](https://github.com/Rigellute/spotify-tui) and [ncspot](https://github.com/hrkfdn/ncspot).

0 commit comments

Comments
 (0)