blob: b5753374549c6836952aba8cfb7a9773bed68206 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
# annotate-rust
A work in progress Rust annotator for
[git.sr.ht](https://git.sr.ht)'s
[code annotations](https://man.sr.ht/git.sr.ht/annotations.md) feature.
Build
-----
<!--
Build Status:
* Arch Linux: [](https://builds.sr.ht/~wezm/annotate-rust/arch.yml?)
* Debian: [](https://builds.sr.ht/~wezm/annotate-rust/debian.yml?)
* FreeBSD: [](https://builds.sr.ht/~wezm/annotate-rust/freebsd.yml?)
-->
To build annotate-rust you will need a [Rust installation][rustup]. Build as
follows:
git clone https://git.sr.ht/~wezm/annotate-rust && cd annotate-rust
cargo build --release
The built binary will be in `target/release/annotaterust`.
<!--
Testing
-------
Run the test suite:
cargo test
-->
Contributing
------------
If you have code or patches you wish to contribute, the preferred mechanism is
a git pull request. Push your changes to a git repository somewhere (Sourcehut,
GitHub, GitLab, whatever). <!--Ensure that contributions don't break [the
tests](#testing) and add new ones when appropriate.-->
Assuming you have followed the [build steps](#build) above you would do the
following to push to your own fork on Sourcehut or your preferred git host:
Change the git URL to match wherever your forked repo is:
git remote rename origin upstream
git remote add origin git@git.sr.ht:~yourname/annotate-rust
git push -u origin master
Then generate the pull request:
git fetch upstream master
git request-pull -p upstream/master origin
And copy-paste the result into a plain-text [email to me](mailto:wes@wezm.net).
You may alternately use a patch-based approach as described on
<https://git-send-email.io>.
[rustup]: https://www.rust-lang.org/tools/install
|
