From 73f26e121c3929d0f416e8ac5d7bac6317855854 Mon Sep 17 00:00:00 2001 From: Lars Noack Date: Tue, 7 May 2024 08:53:41 +0200 Subject: [PATCH] feat: updated installing instructions --- .vscode/settings.json | 1 + README.md | 65 +++++++++++++------------------------------ 2 files changed, 20 insertions(+), 46 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 64b7f98..d8e7fc7 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -22,6 +22,7 @@ "dotenv", "encyclopaedia", "ENDC", + "Gitea", "levenshtein", "metallum", "musify", diff --git a/README.md b/README.md index bc14167..c1936cf 100644 --- a/README.md +++ b/README.md @@ -4,59 +4,39 @@ music kraken logo -- [Music Kraken](#music-kraken) - - [Installation](#installation) - - [From source](#from-source) - - [Notes for WSL](#notes-for-wsl) - - [Quick-Guide](#quick-guide) - - [Query](#query) - - [CONTRIBUTE](#contribute) - - [Matrix Space](#matrix-space) - - [TODO till the next release](#todo-till-the-next-release) -- [Programming Interface / Use as Library](#programming-interface--use-as-library) - - [Quick Overview](#quick-overview) - - [Data Model](#data-model) - - [Data Objects](#data-objects) - - [Creation](#creation) - +- [Installation](#installation) +- [Quick-Guide](#quick-guide) + - [How to search properly](#query) +- [CONTRIBUTE](#contribute) +- [Matrix Space](#matrix-space) --- ## Installation -You can find and get this project from either [PyPI](https://pypi.org/project/music-kraken/) as a Python-Package, -or simply the source code from [GitHub](https://github.com/HeIIow2/music-downloader). Note that even though -everything **SHOULD** work cross-platform, I have only tested it on Ubuntu. -If you enjoy this project, feel free to give it a star on GitHub. +You can find and get this project from either [PyPI](https://pypi.org/project/music-kraken/) as a Python-Package, +or simply the source code from [Gitea](https://gitea.elara.ws/music-kraken/music-kraken-core). ** -> THE PyPI PACKAGE IS OUTDATED +> **NOTES** +> +> - Even though everything **SHOULD** work cross-platform, I have only tested it on Ubuntu. +If you enjoy this project, feel free to give it a star on GitHub. ### From source -if you use Debian or Ubuntu: - ```sh -git clone https://github.com/HeIIow2/music-downloader -sudo apt install pandoc - -cd music-downloader/ -python3 -m pip install -r requirements.txt +git clone https://gitea.elara.ws/music-kraken/music-kraken-core.git +python3 -m pip install -e music-kraken-core/ ``` -then you can add to `~/.bashrc` +To update the program, if installed like this, go into the `music-kraken-core` directory and run `git pull`. -``` -alias music-kraken='cd your/directory/music-downloader/src; python3 -m music_kraken' -alias 🥺='sudo' -``` +### Get it running on other Systems -```sh -source ~/.bashrc -music-kraken -``` +Here are the collected issues, that are related to running the program on different systems. If you have any issues, feel free to open a new one. -### Notes for WSL +#### Windows + WSL -If you choose to run it in WSL, make sure ` ~/.local/bin` is added to your `$PATH` [#2][i2] +Add ` ~/.local/bin` to your `$PATH`. [#2][i2] ## Quick-Guide @@ -87,7 +67,7 @@ The escape character is as usual `\`. --- -## CONTRIBUTE +## Contribute I am happy about every pull request. To contribute look [here](contribute.md). @@ -99,13 +79,6 @@ I decided against creating a discord server, due to various communities get ofte **Click [this invitation](https://matrix.to/#/#music-kraken:matrix.org) _([https://matrix.to/#/#music-kraken:matrix.org](https://matrix.to/#/#music-kraken:matrix.org))_ to join.** -## TODO till the next release - -> These Points will most likely be in the changelogs. - -- [x] Migrate away from pandoc, to a more lightweight alternative, that can be installed over PiPY. -- [ ] Update the Documentation of the internal structure. _(could be pushed back one release)_ - --- # Programming Interface / Use as Library