From 182cbe67ca7450d350228efc5cfaf7757abaa0de Mon Sep 17 00:00:00 2001 From: Felix Ableitner Date: Thu, 22 Dec 2022 17:07:14 +0100 Subject: [PATCH] update readme --- .drone.yml | 8 ++++++++ README.md | 11 ++++++----- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/.drone.yml b/.drone.yml index 75cdd0c..499a2c3 100644 --- a/.drone.yml +++ b/.drone.yml @@ -25,6 +25,14 @@ steps: commands: - /root/.cargo/bin/cargo fmt -- --check + - name: cargo clippy + image: rust:1.66-buster + environment: + CARGO_HOME: .cargo + commands: + - cargo check + - cargo check --features embed-lemmy + - name: cargo clippy image: rust:1.66-buster environment: diff --git a/README.md b/README.md index b577320..554e14c 100644 --- a/README.md +++ b/README.md @@ -169,17 +169,18 @@ Note, you must subscribe manually to remote communities, so that new activities ## Development -Execute the following command, with a Lemmy instance of your choice: -``` +You need to install git and Rust. The easiest way is to develop with an embedded Lemmy instance: +```bash git clone https://github.com/LemmyNet/lemmyBB.git --recursive cd lemmyBB -LEMMYBB_BACKEND=https://lemmy.ml cargo run +cargo run --features embed-lemmy ``` -You can also run a local development instance of Lemmy, either [native](https://join-lemmy.org/docs/en/contributing/local_development.html) or in [Docker](https://join-lemmy.org/docs/en/contributing/docker_development.html), and connect to it with: +Then open http://127.0.0.1:1244 in your browser. +It can also be useful to use a production instance as backend, for example if you notice a bug on a specific instance but don't know what causes it. To do this, run the following command with an instance of your choice. ``` -LEMMYBB_BACKEND=http://localhost:8536 cargo run +LEMMYBB_BACKEND=https://lemmy.ml cargo run ``` ## License