From ef11ed9ee7abc21e0b47c4804c2ec8e6f357236e Mon Sep 17 00:00:00 2001 From: nukeop <12746779+nukeop@users.noreply.github.com> Date: Mon, 10 May 2021 23:30:04 +0000 Subject: [PATCH] Update README.md --- README.md | 60 ++++++++++--------------------------------------------- 1 file changed, 10 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 3ad059735a..aacadac91c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # ![nuclear](https://i.imgur.com/oT1006i.png) -[![Maintainability](https://api.codeclimate.com/v1/badges/a15c4888a63c900f6cc1/maintainability)](https://codeclimate.com/github/nukeop/nuclear/maintainability) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/30750586202742279fa8958a12e519ed)](https://www.codacy.com/app/nukeop/nuclear?utm_source=github.com&utm_medium=referral&utm_content=nukeop/nuclear&utm_campaign=Badge_Grade) [![nuclear](https://snapcraft.io//nuclear/badge.svg)](https://snapcraft.io/nuclear) +[![Maintainability](https://api.codeclimate.com/v1/badges/a15c4888a63c900f6cc1/maintainability)](https://codeclimate.com/github/nukeop/nuclear/maintainability) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/30750586202742279fa8958a12e519ed)](https://www.codacy.com/app/nukeop/nuclear?utm_source=github.com&utm_medium=referral&utm_content=nukeop/nuclear&utm_campaign=Badge_Grade) [![nuclear](https://snapcraft.io//nuclear/badge.svg)](https://snapcraft.io/nuclear) [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/JqPjKxE) Desktop music player focused on streaming from free sources @@ -9,6 +9,8 @@ Desktop music player focused on streaming from free sources [Official website](https://nuclear.js.org) +[Downloads](https://github.com/nukeop/nuclear/releases) + [Documentation](https://nukeop.gitbook.io/nuclear/) [Mastodon](https://mstdn.io/@nuclear) @@ -17,7 +19,7 @@ Desktop music player focused on streaming from free sources Support channel (Matrix): `#nuclear:matrix.org` -Discord channel: https://discord.gg/JqPjKxE +Discord chat: https://discord.gg/JqPjKxE Readme translations: @@ -58,6 +60,12 @@ See [this](docs/electron.md). - No CoC - No CLA +## Development process + +First of all, be sure to check out the [Contribution Guidelines](https://nukeop.gitbook.io/nuclear/contributing/contribution-guidelines). + +The instructions for running Nuclear in development mode can be found in the [Development Process](https://nukeop.gitbook.io/nuclear/developer-resources/development-process) document. + ## Community-maintained packages Here's a list of packages for various managers, some of which are maintained by third parties. We would like to thank the maintainers for their work. @@ -99,54 +107,6 @@ Nuclear has already been translated to several languages, and we're always looki | Finnish | [cjola002-xamk](https://github.com/cjola002-xamk) | | Korean | [dexterastin](https://github.com/dexterastin), [teamzamong](https://github.com/teamzamong/) | - - -## Development process - -First of all, be sure to check out the [Contribution Guidelines](https://nukeop.gitbook.io/nuclear/contributing/contribution-guidelines). - -Use npm: -```shell -$ npm install # installs dependencies -$ npm start -``` - -A new window should open that will load the web app and run Nuclear. - ---- -To build for current operating system: -```shell -$ lerna bootstrap -$ npm run build -``` - -Instead of `build` you can use `build:all` to build for all operating systems. The binaries will be in `packages/app/release` - ---- -It's also possible to run the development environment using docker containers, but this should be considered experimental. - -You will need docker and docker-compose. You need to allow the root user to connect to X11 display, and then you can run docker-compose: - -```shell -$ xhost SI:localuser:root -$ sudo docker-compose up dev -``` -As of now you can also build a flatpak version. You will need to install gobject-introspection, and flatpak-builder. After this you will need to install the runtimes and depedencies required by flatpak-builder for the compile process. You will need the 19.08 version of these flatpaks. -```shell -$ flatpak install flathub org.freedesktop.Platform -$ flatpak install flathub org.freedesktop.Sdk -$ flatpak install flathub io.atom.electron.BaseApp -``` -Next, to build the project (use the `--verbose` flag to get more output): -```shell -$ flatpak-builder build-dir org.js.nuclear.Nuclear.json -``` -To run the built app: -```shell -$ flatpak-builder --run build-dir org.js.nuclear.Nuclear.json run.sh -``` -You can turn the app to a local repo. currently the file builds the latest release. - ## Screenshots This will be updated as the program evolves.