Skip to content

Commit caee5ce

Browse files
committed
docs: update for usage with rust
1 parent d87bc27 commit caee5ce

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,18 @@ Installing with a package manager is recommended.
1818
choco install multibrowse
1919
```
2020

21-
### Manual
21+
### Manual Installation
2222

2323
Binaries can be found on the [releases page](https://github.com/foxxyz/multibrowse/releases). To build yourself, see below.
2424

25+
### Additional Requirements (Linux)
26+
27+
On linux, `xrandr` is used to find display configuration and must be available on `PATH`.
28+
29+
To install:
30+
* Install with Apt: `apt install lxrandr`
31+
* Install with Pacman: `pacman -S xorg-xrandr`
32+
2533
Usage
2634
-----
2735

@@ -50,33 +58,21 @@ Displays are ordered according to their x/y position from left to right, then to
5058
Additional CLI options passed to the `multibrowse` binary will be delegated to the browser instance. Check out the [wiki page](https://github.com/foxxyz/multibrowse/wiki) for common options.
5159

5260

53-
Development Requirements
54-
------------------------
55-
56-
* Python 3
61+
Development
62+
-----------
5763

58-
### Linux
64+
### Requirements
5965

60-
* `xrandr`
61-
* Install with Apt: `apt-get install lxrandr`
62-
* Install with Pacman: `pacman -S xorg-xrandr`
66+
* Rust
6367

64-
### MacOS
65-
66-
* PyObjC
67-
* Install with pip: `pip install pyobjc`
68+
### Running
6869

70+
`cargo run`
6971

7072
Building
7173
--------
7274

73-
Multibrowse can be built into a single contained .exe file using [pyinstaller](http://www.pyinstaller.org/). Pyinstaller can be installed using `pip install pyinstaller`.
74-
75-
The following command produces a single self-contained exe file in `/dist`:
76-
77-
```
78-
pyinstaller --onefile multibrowse.py
79-
```
75+
`cargo build --release`
8076

8177
License
8278
-------

0 commit comments

Comments
 (0)