Skip to content

Commit

Permalink
Document fork in README
Browse files Browse the repository at this point in the history
  • Loading branch information
cass-uredium committed Jan 28, 2025
1 parent 78fc32c commit b25106b
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
![img](https://github.com/PolyMeilex/rfd/assets/20758186/9bef59fa-60f0-448c-b9db-44ab436ee611)


[![version](https://img.shields.io/crates/v/rfd.svg)](https://crates.io/crates/rfd)
[![Documentation](https://docs.rs/rfd/badge.svg)](https://docs.rs/rfd)
[![dependency status](https://deps.rs/crate/rfd/0.15.1/status.svg)](https://deps.rs/crate/rfd/0.15.1)

# `robius-file-dialogs`

`robius-file-dialogs` is a fork of the Rusty File Dialogs ([`rfd`](https://crates.io/crates/rfd)) crate, with minimal compatibility changes for use in the Robius project and other cross-platform applications.
In general, it is kept up to date with [upstream](https://github.com/PolyMeilex/rfd), where changes beneficial to the broader community are also shared.

## Description

Rusty File Dialogs is a cross platform Rust library for using native file open/save dialogs.
It provides both asynchronous and synchronous APIs. Supported platforms:

Expand All @@ -15,8 +19,8 @@ It provides both asynchronous and synchronous APIs. Supported platforms:

Refer to the [documentation](https://docs.rs/rfd) for more details.


## Platform-specific notes

### Linux

Please refer to [Linux & BSD backends](https://docs.rs/rfd/latest/rfd/#linux--bsd-backends) for information about the needed dependencies to be able to compile on Linux.

0 comments on commit b25106b

Please sign in to comment.