Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nutomic committed Dec 22, 2022
1 parent 09828a6 commit 182cbe6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
8 changes: 8 additions & 0 deletions .drone.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 182cbe6

Please sign in to comment.