matrix-org / matrix-org/rust-synapse-compress-state
How do I start the synapse-compress-state script?
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 173
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
Please add detailed information to the README for someone, who has never used rust before, how to start the script:
# build this rust script
1. install Rust
- on Debian 10:
sudo apt install cargo
- or manual rust install (min needed rust version 1.27)
Make sure to have at least **2GB** free diskspace, then:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`
(choose default if asked)
2. clone this repo
git clone https://github.com/matrix-org/
cd rust-synapse-compress-state
3. configure the current shell
source $HOME/.cargo/env
4. build the script
cargo build
Now you can run the script in `target/debug/synapse-compress-state`
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Update the README with the installation, repository cloning, shell configuration, and cargo build steps described in the issue. Start by reading the current README and verify that the documented command produces target/debug/synapse-compress-state; done means a Rust newcomer can build and locate the script.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100