diff --git a/README.md b/README.md index 19cadee..9b09d36 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ -# deemix-gui -An electron app that wraps deemix-webui and lets you use the deemix-js library +# Deemixer -## Downloads -Downloads are available [here](https://www.reddit.com/r/deemix/comments/hmrhhs/download_links/) +This is forked from [deemix-webui](https://gitlab.com/RemixDev/deemix-webui) and [deemix-gui](https://gitlab.com/RemixDev/deemix-webui). + +The submodule reference was removed and consolidated into this single repo. Git history was maintained. ## Running from source -You need to use nodejs 16.x, using `yarn` is recommended. -If you're using git to get this repo you should use `git submodule update --init --recursive` as well. If you're just downloading the archive.zip, make sure you download and extract deemix-webui into the webui folder. +You need to use nodejs 16.x, using `yarn` is recommended. Install the dependencies using `yarn install-all` for production. Install the dependencies using `yarn install-all-dev` for development. @@ -18,22 +17,25 @@ Commands for easy setup: ```sh # Production -git clone https://gitlab.com/RemixDev/deemix-gui.git . && git submodule update --init --recursive && yarn install-all +git clone https://gitea.va.reichard.io/evan/Deemixer.git . && yarn install-all # Development -git clone https://gitlab.com/RemixDev/deemix-gui.git . && git submodule update --init --recursive && yarn install-all-dev +git clone https://gitea.va.reichard.io/evan/Deemixer.git . && yarn install-all-dev ``` You can change the default port by setting the environment variable `PORT` to any other number before starting the app. ## Building the app + To build the app you need to have git installed and the repo cloned with `git`. Make sure you've installed the dependencies for all packages (the root folder, `server` and `webui`). Then from the root folder run `yarn dist` to make a distributable package for your current OS or `yarn dist-server` to make an executable for only the server. ## Feature requests + Before asking for a feature make sure it isn't an already open issue on the repo # License + This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or @@ -41,7 +43,7 @@ the Free Software Foundation, either version 3 of the License, or This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License