From d53a31c53cd11447ccccb6f962fafe9556ca13b1 Mon Sep 17 00:00:00 2001 From: soc Date: Wed, 15 Sep 2021 23:27:31 +0200 Subject: [PATCH 1/3] Add GitHub Action --- .github/workflows/rust.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/rust.yml diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..0346ed1 --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,22 @@ +name: Rust + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + + runs-on: [ ubuntu-latest, windows-latest, macos-latest ] + + steps: + - uses: actions/checkout@v2 + - name: Build + run: cargo build --verbose + - name: Test + run: RUST_BACKTRACE=full cargo test --verbose -- --nocapture From 999efde766ed370a60c58145711db728ae9c04e8 Mon Sep 17 00:00:00 2001 From: soc Date: Mon, 1 Aug 2022 11:52:45 +0200 Subject: [PATCH 2/3] remove obsolete CI links, use new badge style --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c1458bf..57ae25a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ -[![crates.io](https://img.shields.io/crates/v/dirs.svg)](https://crates.io/crates/dirs) -[![API documentation](https://docs.rs/dirs/badge.svg)](https://docs.rs/dirs/) -![actively developed](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg) -[![TravisCI status](https://img.shields.io/travis/dirs-dev/dirs-rs/master.svg?label=Linux/macOS%20build)](https://travis-ci.org/dirs-dev/dirs-rs) -[![AppVeyor status](https://img.shields.io/appveyor/ci/soc/dirs-rs/master.svg?label=Windows%20build)](https://ci.appveyor.com/project/soc/dirs-rs/branch/master) -![License: MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-orange.svg) +[![crates.io](https://img.shields.io/crates/v/dirs.svg?style=for-the-badge)](https://crates.io/crates/dirs) +[![API documentation](https://img.shields.io/docsrs/dirs/latest?style=for-the-badge)](https://docs.rs/dirs/) +![actively developed](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg?style=for-the-badge) +![License: MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-orange.svg?style=for-the-badge) # `dirs` From 98f4e6427dbf0b3939c7046f789b08522f5473d0 Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Thu, 18 Aug 2022 20:42:36 +0800 Subject: [PATCH 3/3] Fix markdown issues in README.md Found via `markdownlint -f README.md --disable MD013 MD033`. --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 57ae25a..044d76c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ +# `dirs` + [![crates.io](https://img.shields.io/crates/v/dirs.svg?style=for-the-badge)](https://crates.io/crates/dirs) [![API documentation](https://img.shields.io/docsrs/dirs/latest?style=for-the-badge)](https://docs.rs/dirs/) ![actively developed](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg?style=for-the-badge) ![License: MIT/Apache-2.0](https://img.shields.io/badge/license-MIT%2FApache--2.0-orange.svg?style=for-the-badge) -# `dirs` - ## Introduction - a tiny low-level library with a minimal API @@ -13,6 +13,7 @@ - on Linux, Redox, Windows (≥ Vista), macOS and other platforms. The library provides the location of these directories by leveraging the mechanisms defined by + - the [XDG base directory](https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) and the [XDG user directory](https://www.freedesktop.org/wiki/Software/xdg-user-dirs/) specifications on Linux and Redox - the [Known Folder](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378457.aspx) API on Windows @@ -32,7 +33,7 @@ and on the JVM ([directories-jvm](https://github.com/dirs-dev/directories-jvm)). ## Usage -#### Dependency +### Dependency Add the library as a dependency to your project by inserting @@ -44,7 +45,7 @@ into the `[dependencies]` section of your Cargo.toml file. If you are upgrading from version 2, please read the [section on breaking changes](#3) first. -#### Example +### Example Library run by user Alice: @@ -158,7 +159,7 @@ This is helpful to ensure a change hasn't broken code on a different platform. The following commands will build this library on Linux, macOS and Windows: -``` +```sh cargo build --target=x86_64-unknown-linux-gnu cargo build --target=x86_64-pc-windows-gnu cargo build --target=x86_64-apple-darwin @@ -202,10 +203,10 @@ entries on Linux has been improved (contributed by @tmiasko, thank you!): Licensed under either of - * Apache License, Version 2.0 - ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) - * MIT license - ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) +- Apache License, Version 2.0 + ([LICENSE-APACHE](LICENSE-APACHE) or ) +- MIT license + ([LICENSE-MIT](LICENSE-MIT) or ) at your option.