File tree Expand file tree Collapse file tree 3 files changed +28
-4
lines changed Expand file tree Collapse file tree 3 files changed +28
-4
lines changed Original file line number Diff line number Diff line change @@ -4,19 +4,25 @@ The bmap-rs project aims to implement tools related to bmap. The project is writ
4
4
rust. The inspiration for it is an existing project that is written in python called
5
5
[ bmap-tools] ( https://salsa.debian.org/debian/bmap-tools ) .
6
6
7
- Right now the implemented function is copying system images files using bmap, which is
8
- safer and faster than regular cp ro dd. That can be used to flash images into block
7
+ Right now, the implemented function is copying system images files using bmap, which is
8
+ safer and faster than regular cp or dd. That can be used to flash images into block
9
9
devices.
10
10
11
+ ## Installation
12
+ ```
13
+ cargo install bmap-rs
14
+ ```
15
+
11
16
## Usage
12
17
bmap-rs supports 1 subcommand:
13
18
- "copy" - copy a file to another file using a bmap file.
14
19
``` bash
15
- bmap-rs copy < SOURCE_PATH> < TARGET_PATH>
20
+ bmap-rs copy < SOURCE_PATH> / < SOURCE_URL > < TARGET_PATH>
16
21
```
17
22
18
23
The bmap file is automatically searched in the source directory. The recommendation is
19
24
to name it as the source but with bmap extension.
25
+ If the file is remote, the bmap is also searched remotely.
20
26
21
27
## License
22
28
bmap-rs is licensed under dual Apache-2.0 and MIT licenses.
Original file line number Diff line number Diff line change @@ -6,7 +6,7 @@ edition = "2018"
6
6
license = " MIT AND Apache-2.0"
7
7
description = " bmap-parser is a library for Rust that allows you to copy files or flash block devices safely"
8
8
repository = " https://github.com/collabora/bmap-rs"
9
- readme = " ../ README.md"
9
+ readme = " README.md"
10
10
11
11
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
12
12
Original file line number Diff line number Diff line change
1
+ # bmap-parser
2
+
3
+ The bmap-parser crate aims to implement tools related to bmap. The inspiration for it
4
+ is an existing project that is written in python called [ bmap-tools] ( https://salsa.debian.org/debian/bmap-tools ) .
5
+
6
+ Right now, the implemented function is copying system images files using bmap, which is
7
+ safer and faster than regular cp or dd. That can be used to flash images into block
8
+ devices.
9
+
10
+ ## Usage
11
+ ```
12
+ use bmap-parser::*;
13
+ ```
14
+ There is a ` copy ` function that uses bmap file as reference, and a ` copy_async ` for the
15
+ process to work in an asynchronous context.
16
+
17
+ ## License
18
+ bmap-rs is licensed under dual Apache-2.0 and MIT licenses.
You can’t perform that action at this time.
0 commit comments