Skip to content

Commit

Permalink
312: review feedback, remove lint flow, README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jac18281828 committed Nov 8, 2023
1 parent e13740a commit 72673b3
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 27 deletions.
27 changes: 0 additions & 27 deletions .github/workflows/lint.yml

This file was deleted.

3 changes: 3 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ USER xmtp
# fmt coming from nightly
RUN ~xmtp/.cargo/bin/rustup toolchain install nightly
RUN ~xmtp/.cargo/bin/rustup component add rustfmt --toolchain nightly
RUN ~xmtp/.cargo/bin/rustup component add clippy

WORKDIR /workspaces/libxmtp
COPY --chown=xmtp:xmtp . .
Expand All @@ -90,6 +91,8 @@ ENV USER=xmtp
RUN ~xmtp/.cargo/bin/cargo check
RUN ~xmtp/.cargo/bin/cargo +nightly --version
RUN ~xmtp/.cargo/bin/cargo +nightly fmt --check
RUN ~xmtp/.cargo/bin/cargo clippy --all-features --no-deps
RUN ~xmtp/.cargo/bin/cargo clippy --all-features --no-deps --manifest-path xmtp/Cargo.toml
# some tests are setup as integration tests 👀 xmtp_mls
RUN for crate in xmtp xmtp_api_grpc xmtp_api_grpc_gateway xmtp_cryptography xmtp_proto xmtp_v2; do cd ${crate}; ~xmtp/.cargo/bin/cargo test; done

Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ Start Docker Desktop.
dev/test
```

## Quick Start (Dev Containers)

This project supports containerized development. From Visual Studio Code Dev Containers extension specify the Dockerfile as the target:

`Reopen in Container`

or

Command line build using docker

```bash
$ docker build . -t libxmtp:1
```

## Structure

- [`xmtp`](https://github.com/xmtp/libxmtp/tree/main/xmtp): Pure Rust implementation of XMTP APIs, agnostic to any per-language or per-platform binding
Expand Down

0 comments on commit 72673b3

Please sign in to comment.