Merge pull request #231 from GermanBread/master
Clean up the messy README
This commit is contained in:
JeanOUINA
GitHub
commit
55192f0704
141
README.md
141
README.md
|
|
@ -10,84 +10,15 @@
|
|||
[](https://papycochon.github.io/cryptodonate/xmr.html?address=42pGf1KHHpqaifJd3TtWSdcTmhGVwFp24cGxDoqaYLQJ6rH4pM7KqtUdTpoyxHScDTSJpPA2Bnv19b1bs2uPXgSMH2KYkwj¬e=https://github.com/Lightcord/Lightcord)
|
||||
[](https://papycochon.github.io/cryptodonate/eth.html?address=0xEFE45F22Ee844bf2Ba0E4d853FA0bC8c028fAfFe¬e=https://github.com/Lightcord/Lightcord)
|
||||
[](https://papycochon.github.io/cryptodonate/ltc.html?address=LNTmfMjHJgTHaB7rj8ZuWWuU1XkP2YeGCA¬e=https://github.com/Lightcord/Lightcord)
|
||||
---
|
||||
# Lightcord
|
||||
A simple and customizable Discord client
|
||||
|
||||
## What's This?
|
||||
# About
|
||||
|
||||
[Lightcord](https://lightcord.org) is a simple and customizable client for Discord.
|
||||
It includes [BandagedBD](https://github.com/rauenzi/BetterDiscordApp), [Glasstron](https://github.com/AryToNeX/Glasstron) and a [discord.js-like api](https://github.com/Lightcord/Lightcord/tree/master/DiscordJS).
|
||||
|
||||
## Information
|
||||
Lightcord doesn't just *patch* Discord with its content. If it did, Discord updates could easily break it. That's why Lightcord is a standalone Discord client. Just grab the latest release and launch!
|
||||
# Features
|
||||
|
||||
## Installing
|
||||
You can download a release from the [releases tab](https://github.com/Lightcord/Lightcord/releases).
|
||||
|
||||
## Windows
|
||||
|
||||
You can install Lightcord with [scoop](https://github.com/lukesampson/scoop).
|
||||
|
||||
```powershell
|
||||
scoop bucket add extras
|
||||
scoop install lightcord
|
||||
```
|
||||
|
||||
## AUR (Unofficial)
|
||||
You need to install the `base-devel` and `git` packages first
|
||||
|
||||
**For compilation** https://aur.archlinux.org/packages/lightcord-git/
|
||||
|
||||
`git clone https://aur.archlinux.org/lightcord-git.git && cd lightcord-git && makepkg -si`
|
||||
|
||||
**For precompiled binaries** https://aur.archlinux.org/packages/lightcord-bin/
|
||||
|
||||
`git clone https://aur.archlinux.org/lightcord-bin.git && cd lightcord-bin && makepkg -si`
|
||||
|
||||
**For AppImage**
|
||||
|
||||
`git clone https://aur.archlinux.org/lightcord-appimage.git && cd lightcord-appimage && makepkg -si`
|
||||
|
||||
An AUR helper such as `yay` can also be used
|
||||
|
||||
## Other Linux Distributions
|
||||
You can also install it with our *express install script*, which will automatically do the following:
|
||||
- Download the latest Lightcord stable release from the official dev server.
|
||||
- Extract the file and rename it to a more conventional ¨Lightcord¨ folder.
|
||||
- Install the Lightcord files in /opt/.
|
||||
- Add execution rights to the Lightcord executable to allow launching.
|
||||
- Download an appropriate .desktop file and install it in /usr/share/applications.
|
||||
- Add execution rights to the .desktop file to allow launching.
|
||||
- Download the Lightcord icon in the .svg format and install it in /usr/share/pixmaps.
|
||||
|
||||
## Running From Source
|
||||
Prerequisites: [Node.js](https://nodejs.org/en/) and NPM
|
||||
To run from source, follow these instructions:
|
||||
```bash
|
||||
git clone https://github.com/Lightcord/Lightcord
|
||||
cd Lightcord
|
||||
npm run devInstall
|
||||
npm test
|
||||
```
|
||||
*You will have to do that every time you pull/clone*
|
||||
<br/>
|
||||
Lightcord will then launch. If you see the Lightcord icon, you're good to go!
|
||||
|
||||
<br />
|
||||
Any time you want to launch, just run:
|
||||
```bash
|
||||
npm run run
|
||||
```
|
||||
|
||||
*You can install on GNU/Linux with our install script or the AUR*
|
||||
|
||||
## Express Install Script
|
||||
|
||||
- This script requires the `unzip` package to be installed. Use your package manager of choice to install it.
|
||||
|
||||
To install, paste `bash -c "$(curl -s https://raw.githubusercontent.com/Lightcord/Lightcord/master/LULI.sh)"` in terminal and press enter. The installer will guide you through the rest.
|
||||
|
||||
## Features
|
||||
* **Standalone client** - Lightcord is built to be standalone i.e. it will not break on Discord updates!
|
||||
* **BetterDiscord built in** - Use almost any BetterDiscord plugin or theme!
|
||||
* **Easy custom rich presence** - Our method of doing this ensures you won't get banned!
|
||||
* **Made for Privacy** - Lightcord automatically blocks Discord's trackers and blurs your email, keeping your data safe!
|
||||
|
|
@ -100,14 +31,66 @@ To install, paste `bash -c "$(curl -s https://raw.githubusercontent.com/Lightcor
|
|||
* **HypeSquad Housing** - Easily change your HypeSquad house, no test required!
|
||||
* **Badges** - Important people like the developers have special badges to make sure you know who is who!
|
||||
|
||||
### Planned Features
|
||||
## Planned Features
|
||||
|
||||
* **Username History** - Keep track of your past usernames!
|
||||
* **New Plugin Directory** - Easily install or edit themes and plugins!
|
||||
|
||||
## BetterDiscord
|
||||
A modified version of Bandaged Better Discord comes preinstalled, making theming and adding plugins easy.
|
||||
# Installing
|
||||
|
||||
## Plugins & Themes
|
||||
Plugins and themes are not in the standard BetterDiscord folder. They have been moved because BetterDiscord only supports the stable, PTB, and canary releases of Discord. Using the same directory could cause problems with settings.
|
||||
## Windows
|
||||
|
||||
They are located in `%AppData%/Lightcord_BD`. This is the main folder for BetterDiscord.
|
||||
You can install Lightcord with [scoop](https://github.com/lukesampson/scoop).
|
||||
|
||||
```powershell
|
||||
scoop bucket add extras
|
||||
scoop install lightcord
|
||||
```
|
||||
|
||||
Alternatively, download the installer from the [releases tab](https://github.com/Lightcord/Lightcord/releases).
|
||||
|
||||
## Linux
|
||||
|
||||
### Arch Linux (or Arch-based)
|
||||
|
||||
You need to install the `base-devel` and `git` packages first
|
||||
|
||||
[Latest git version](https://aur.archlinux.org/packages/lightcord-git/)
|
||||
|
||||
`git clone https://aur.archlinux.org/lightcord-git.git && cd lightcord-git && makepkg -si`
|
||||
|
||||
[Precompiled binaries](https://aur.archlinux.org/packages/lightcord-bin/)
|
||||
|
||||
`git clone https://aur.archlinux.org/lightcord-bin.git && cd lightcord-bin && makepkg -si`
|
||||
|
||||
*AUR helper such as `yay` and `pacaur` can also be used*
|
||||
|
||||
### Other Linux Distributions
|
||||
|
||||
**Warning: This installation method bypasses the package manager!** You should use this script to uninstall Lightcord!
|
||||
|
||||
To install, paste `bash -c "$(curl -s https://raw.githubusercontent.com/Lightcord/Lightcord/master/LULI.sh)"` in terminal and press enter. The installer will guide you through the rest.
|
||||
|
||||
# Running From Source
|
||||
|
||||
Prerequisites: [Node.js](https://nodejs.org/en/) and NPM
|
||||
To run from source, follow these instructions:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Lightcord/Lightcord
|
||||
cd Lightcord
|
||||
npm run devInstall
|
||||
npm test
|
||||
```
|
||||
|
||||
*You will have to do that every time you pull/clone*
|
||||
|
||||
Lightcord will then launch. If you see the Lightcord icon, you're good to go!
|
||||
|
||||
|
||||
|
||||
Any time you want to launch, just run:
|
||||
|
||||
```bash
|
||||
npm run run
|
||||
```
|
||||
Loading…
Reference in New Issue