Commit Graph

60 Commits

Author SHA1 Message Date
cyqsimon
9454f51882 Update CONTRIBUTING information 2024-10-09 23:41:46 +08:00
cyqsimon
c255c084f6 Update usage in README (#409)
* Update usage

* Write changelog
2024-04-17 10:07:58 +08:00
cyqsimon
6a67ed03e9 Minor fix in README table 2024-04-16 16:07:26 +08:00
cyqsimon
f98c5c9cd6 Update README (#407)
* Update README

* Write changelog
2024-04-16 16:04:16 +08:00
David Legrand
cc5685ba6c docs: add Exherbo Linux install instructions in README.md (#398) 2024-04-07 17:56:57 +08:00
Felix Obenhuber
9354683481 Enable Android build (#384)
* Support build for target_os android

The target_os `android` is quite similar to `linux` but must be
mentioned in the guards explicitly. Tested for target
`aarch64-linux-android`.

* Add target aarch64-linux-android to ci

Use `cross` for building target `aarch64-linux-android`. In the `ci`
workflow the matrix branch of `os` `ubuntu-latest` is used because the
matrix organization is host os centric instead of target.

Releases are build with `cross` for target `aarch64-linux-android`.

Install `cross` if needed for a run. At the time of writing the latest
release of `cross` can't build binaries for target
`aarch64-linux-android` and it's common sense that the latest git tag or
`master` shall be used [1].

[1] https://github.com/cross-rs/cross/issues/1222

* Add android related readme section
2024-04-02 17:39:24 +08:00
cyqsimon
5f5cc7ed60 Add co-maintainership invitation 2024-02-05 12:11:54 +08:00
cyqsimon
cf9b9f0634 Reorganise & cleanup (#329)
* Get rid of outdated, unused packaging files

* Create `/res`
2023-11-02 00:59:56 +08:00
cyqsimon
d75de8e948 Update table of contents 2023-10-07 17:46:14 +08:00
cyqsimon
439355ffb3 Add downstream packaging tracking table (repology)
- Closes #287
2023-09-20 10:08:15 +08:00
cyqsimon
20410739d7 Add project status section in README 2023-08-30 11:44:43 +08:00
cyqsimon
53af5b8e2f Improve Linux privilege escalation instructions
- There are merits to always use `sudo` as opposed to `setcap`.
2023-08-30 11:27:16 +08:00
cyqsimon
3969767752 Bump MSRV from 1.65.0 to 1.70.0
- Due to use of `OnceCell`: see #278
2023-08-27 23:07:08 +08:00
cyqsimon
c780c06807 Fix TOC 2023-08-25 18:39:53 +08:00
cyqsimon
08db9a8bf6 Update README 2023-08-25 18:38:12 +08:00
cyqsimon
66ba68954e Update MSRV 2023-08-25 17:20:17 +08:00
cyqsimon
df2a57c7b6 Improve Homebrew instructions on Linux
- Fixes #228
2023-08-25 16:45:25 +08:00
freddii
0d7b410cfd fixed spelling mistake 2023-08-25 16:14:17 +08:00
Teoh Han Hui
e4420fbfc6 Fix setcap example
* Use POSIX sh command substitution syntax
* Use `command -v` shell built-in instead of `which`
2023-08-25 16:13:44 +08:00
Herby Gillot
3d2599aefb docs(readme): add instructions for installing via MacPorts 2023-08-25 16:12:30 +08:00
Aram Drevekenin
a703513412 chore(release): 0.20.0 2020-10-15 11:05:36 +02:00
Aram Drevekenin
8020b94914 docs(readme): update for windows and re-order installation instructions 2020-09-20 13:57:45 +02:00
Aram Drevekenin
27d3093d00 docs(readme): windows installation instructions 2020-09-11 10:33:14 +02:00
Petteri Valkonen
16d9758abf docs(readme): add FreeBSD installation instructions (#183) 2020-09-09 10:22:55 +02:00
Omer Katz
724bafcc80 docs(readme): brew works on Linux too (#171)
* brew works on Linux too.

Linuxbrew has been merged back to Homebrew so this tools can be installed using `brew install`.

* docs(readme): clarify brew installation

Co-authored-by: Aram Drevekenin <aram@poor.dev>
2020-06-06 09:00:36 +02:00
Aram Drevekenin
b05d9bff81 docs(fix): remove accidental duplication 2020-05-23 14:35:19 +02:00
Aram Drevekenin
c43a90cdd5 docs(readme): rearrange installation instructions 2020-05-23 14:34:26 +02:00
Aram Drevekenin
41b5ce787a docs(readme): OpenWRT installation instructions 2020-05-23 14:32:25 +02:00
Aram Drevekenin
ce0b1f5d84 docs(readme): update utilization and bump version 2020-04-05 19:03:43 +02:00
axel simon
fe642f8807 docs(readme): correct/improve a few typos (#151)
* Correct/improve a few typos

* Add suggestion to use sudo -E

sudo -E inherits current users environment variables
2020-03-10 10:01:17 +01:00
Kelvin Zhang
833577e0b6 Merge pull request #135 from zhangxp1998/setcap
Update description about capabilities needed
2020-01-18 09:17:02 -05:00
Kelvin Zhang
075f858e8f Update description about capabilities needed 2020-01-18 09:01:07 -05:00
Aram Drevekenin
e2a081a843 docs(readme): update usage 2020-01-18 11:57:44 +01:00
Kelvin Zhang
6de8270422 Add explanation about difference between setcap and sudo 2020-01-17 12:35:00 -05:00
Eirik A
f6ceb447d5 README: fix setcap syntax
setcap+=ep did not work for me, needed to take off the equals sign
2020-01-17 12:22:00 -05:00
Artem Polishchuk
6cdce9701f Add Fedora installation instructions 2020-01-15 12:44:18 -05:00
kpcyrd
6ffd4d445f docs(readme): arch Linux: Recommend pacman instead of yay (#103) 2020-01-09 20:08:48 +01:00
Jan Christian Grünhage
8f87a9a17e docs(readme): add voidlinux installation instructions (#102) 2020-01-09 20:07:25 +01:00
BSKY
ba82d37ecd chore(packaging): add installation instruction with brew (#75)
* Update README.md

* docs(comment): warning not to break homebrew test

Co-authored-by: Aram Drevekenin <aram@poor.dev>
2020-01-05 20:40:41 +01:00
ebroto
6b5462fe08 docs(readme): Add MSRV and cargo installation instructions (#66) 2020-01-03 20:02:45 +01:00
Oleksii Filonenko
b08d677dd5 chore(packaging): add installation notes for Nix/NixOS (#32) 2020-01-02 09:17:22 +01:00
Hugo Locurcio
0975a0bf6f docs(readme): mention setcap to set the binary capability on bandwhich (#57)
See #30.

This also boldens the part that mentions root privileges are required
to make it easier to notice.

Co-authored-by: Aram Drevekenin <aram@poor.dev>
2020-01-02 08:41:05 +01:00
Loy
43618d32aa Extend installation steps with sudo-able paths (#42)
* Extend installation steps with sudo-able paths

Fixes https://github.com/imsnif/what/issues/30

* Change name to 'bandwhich'

* Add setcap option for installation

* Fix typo and make path uniform with other options

Co-Authored-By: Oleksii Filonenko <brightone@protonmail.com>

* docs(readme): rework sections

Co-authored-by: Oleksii Filonenko <brightone@protonmail.com>
Co-authored-by: Aram Drevekenin <aram@poor.dev>
2020-01-02 08:33:20 +01:00
Aram Drevekenin
f78725f4ff docs(readme): remove tagline 2019-12-30 22:16:46 +01:00
Aram Drevekenin
92f0872ec3 chore(rename): what ==> bandwhich 2019-12-30 21:41:19 +01:00
Eduardo Broto
6436b7d70a docs(readme): Update usage and some uses after making -i optional 2019-12-20 20:28:55 +01:00
Aram Drevekenin
b31d053947 docs(readme): update contributing section 2019-11-25 22:24:05 +01:00
Aram Drevekenin
bf14f15815 docs(readme): update installation instructions 2019-11-13 15:43:26 +01:00
Aram Drevekenin
43e1e9b09a docs(readme): update macos information 2019-11-12 11:54:29 +01:00
Aram Drevekenin
acea124cc3 docs(readme): Add arch linux installation - yay! 2019-11-11 21:04:53 +01:00