From ee4d7bb4ab450057a71d7d0cbd0f438241e185bb Mon Sep 17 00:00:00 2001 From: OMGparticles Date: Sun, 3 Dec 2023 17:00:58 -0800 Subject: [PATCH 1/3] Fix broken readme links and make links relative - Fixed broken links to local repository directories. - Minor grammar change. --- README.md | 6 +++--- examples/README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 79ab33b..aa65590 100644 --- a/README.md +++ b/README.md @@ -138,13 +138,13 @@ e.g. cargo run --example with_nannou ``` -Please check the [README](https://github.com/alisomay/libpd-rs/examples) on examples for more information. +Please check the [README](https://github.com/alisomay/libpd-rs/tree/main/examples) on examples for more information. For the tests, you may run `cargo test` directly. ## Next steps -Please check the [examples](https://github.com/alisomay/libpd-rs/examples) and [tests](https://github.com/alisomay/libpd-rs/tests) directory if you're learning better when reading code. +Please check the [examples](https://github.com/alisomay/libpd-rs/tree/main/examples) and [tests](https://github.com/alisomay/libpd-rs/tree/main/tests) directories if you learn better when reading code. Or if you would like to dive in to [documentation](https://docs.rs/libpd-rs/0.1.9/libpd_rs/#) please go ahead. @@ -171,7 +171,7 @@ Or if you would like to dive in to [documentation](https://docs.rs/libpd-rs/0.1. - [Multi hooks support](https://github.com/libpd/libpd/pull/282/files#diff-51ce01cd8a0f2a0249dc73e318ccfb430fbe0e341edfd69a8a83ccd81f58e29aR502) - [Multi instance support](https://github.com/libpd/libpd/blob/master/libpd_wrapper/z_libpd.h#L529) - Support for Android and IOS -- Enrich [examples](https://github.com/alisomay/libpd-rs/examples) with nice patches and add also examples with [bevy](https://bevyengine.org/) and [nannou](https://github.com/nannou-org/nannou). +- Enrich [examples](https://github.com/alisomay/libpd-rs/tree/main/examples) with nice patches and add also examples with [bevy](https://bevyengine.org/) and [nannou](https://github.com/nannou-org/nannou). ## Support diff --git a/examples/README.md b/examples/README.md index e764113..601d8ee 100644 --- a/examples/README.md +++ b/examples/README.md @@ -26,4 +26,4 @@ Here is an example to mess around: cargo run --example with_nannou ``` -Please also check the [tests](https://github.com/alisomay/libpd-rs/tests) folder if you'd like to explore example like code. +Please also check the [tests](https://github.com/alisomay/libpd-rs/tree/main/tests) folder if you'd like to explore example like code. From eb97858f836a3dedc4e823314aa552f70cee9225 Mon Sep 17 00:00:00 2001 From: OMGparticles Date: Sun, 3 Dec 2023 17:20:28 -0800 Subject: [PATCH 2/3] Made local readme links relative - Readme links to local files or directories are now relative. - Readme links to documentation now link to the latest version. --- README.md | 12 ++++++------ examples/README.md | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index aa65590..2842d5f 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ Safe rust abstractions over [libpd-sys](https://github.com/alisomay/libpd-sys). Though pd is designed as a desktop application, [libpd](https://github.com/libpd) is an open source project which exposes it as a C library opening the possibility to embed the functionality of pd to any platform which C can compile to. -[libpd-rs](https://github.com/alisomay/libpd-rs) aims to bring [libpd](https://github.com/libpd) to the Rust [ecosystem](https://crates.io/). It aims to expose the full functionality of [libpd](https://github.com/libpd) with some extra additions such as bundling commonly used externals and addition of extra functionality for increased ease of use. +[libpd-rs](/) aims to bring [libpd](https://github.com/libpd) to the Rust [ecosystem](https://crates.io/). It aims to expose the full functionality of [libpd](https://github.com/libpd) with some extra additions such as bundling commonly used externals and addition of extra functionality for increased ease of use. -It is thoroughly [documented](https://docs.rs/libpd-rs/0.1.9/libpd_rs/#), well [tested](https://github.com/alisomay/libpd-rs/tree/main/tests) and enriched with various [examples](https://github.com/alisomay/libpd-rs/tree/main/examples) to get you started right away. +It is thoroughly [documented](https://docs.rs/libpd-rs/latest/libpd_rs/#), well [tested](/tree/main/tests/) and enriched with various [examples](/tree/main/examples/) to get you started right away. Now let's make some sound! 🔔 @@ -138,15 +138,15 @@ e.g. cargo run --example with_nannou ``` -Please check the [README](https://github.com/alisomay/libpd-rs/tree/main/examples) on examples for more information. +Please check the [README](/tree/main/examples/) on examples for more information. For the tests, you may run `cargo test` directly. ## Next steps -Please check the [examples](https://github.com/alisomay/libpd-rs/tree/main/examples) and [tests](https://github.com/alisomay/libpd-rs/tree/main/tests) directories if you learn better when reading code. +Please check the [examples](/tree/main/examples/) and [tests](/tree/main/tests/) directories if you learn better when reading code. -Or if you would like to dive in to [documentation](https://docs.rs/libpd-rs/0.1.9/libpd_rs/#) please go ahead. +Or if you would like to dive in to [documentation](https://docs.rs/libpd-rs/latest/libpd_rs/#) please go ahead. ## Resources @@ -171,7 +171,7 @@ Or if you would like to dive in to [documentation](https://docs.rs/libpd-rs/0.1. - [Multi hooks support](https://github.com/libpd/libpd/pull/282/files#diff-51ce01cd8a0f2a0249dc73e318ccfb430fbe0e341edfd69a8a83ccd81f58e29aR502) - [Multi instance support](https://github.com/libpd/libpd/blob/master/libpd_wrapper/z_libpd.h#L529) - Support for Android and IOS -- Enrich [examples](https://github.com/alisomay/libpd-rs/tree/main/examples) with nice patches and add also examples with [bevy](https://bevyengine.org/) and [nannou](https://github.com/nannou-org/nannou). +- Enrich [examples](/tree/main/examples/) with nice patches and add also examples with [bevy](https://bevyengine.org/) and [nannou](https://github.com/nannou-org/nannou). ## Support diff --git a/examples/README.md b/examples/README.md index 601d8ee..244203d 100644 --- a/examples/README.md +++ b/examples/README.md @@ -26,4 +26,4 @@ Here is an example to mess around: cargo run --example with_nannou ``` -Please also check the [tests](https://github.com/alisomay/libpd-rs/tree/main/tests) folder if you'd like to explore example like code. +Please also check the [tests](/tree/main/tests/) folder if you'd like to explore example like code. From 1405fc56f0f5e56ee27d7e3e481535354ce7b28e Mon Sep 17 00:00:00 2001 From: OMGparticles Date: Sun, 3 Dec 2023 17:24:54 -0800 Subject: [PATCH 3/3] Fixed relative links - Removed `/tree/main` from the relative links --- README.md | 8 ++++---- examples/README.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2842d5f..cd1cd18 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Though pd is designed as a desktop application, [libpd](https://github.com/libpd [libpd-rs](/) aims to bring [libpd](https://github.com/libpd) to the Rust [ecosystem](https://crates.io/). It aims to expose the full functionality of [libpd](https://github.com/libpd) with some extra additions such as bundling commonly used externals and addition of extra functionality for increased ease of use. -It is thoroughly [documented](https://docs.rs/libpd-rs/latest/libpd_rs/#), well [tested](/tree/main/tests/) and enriched with various [examples](/tree/main/examples/) to get you started right away. +It is thoroughly [documented](https://docs.rs/libpd-rs/latest/libpd_rs/#), well [tested](/tests/) and enriched with various [examples](/examples/) to get you started right away. Now let's make some sound! 🔔 @@ -138,13 +138,13 @@ e.g. cargo run --example with_nannou ``` -Please check the [README](/tree/main/examples/) on examples for more information. +Please check the [README](/examples/) on examples for more information. For the tests, you may run `cargo test` directly. ## Next steps -Please check the [examples](/tree/main/examples/) and [tests](/tree/main/tests/) directories if you learn better when reading code. +Please check the [examples](/examples/) and [tests](/tests/) directories if you learn better when reading code. Or if you would like to dive in to [documentation](https://docs.rs/libpd-rs/latest/libpd_rs/#) please go ahead. @@ -171,7 +171,7 @@ Or if you would like to dive in to [documentation](https://docs.rs/libpd-rs/late - [Multi hooks support](https://github.com/libpd/libpd/pull/282/files#diff-51ce01cd8a0f2a0249dc73e318ccfb430fbe0e341edfd69a8a83ccd81f58e29aR502) - [Multi instance support](https://github.com/libpd/libpd/blob/master/libpd_wrapper/z_libpd.h#L529) - Support for Android and IOS -- Enrich [examples](/tree/main/examples/) with nice patches and add also examples with [bevy](https://bevyengine.org/) and [nannou](https://github.com/nannou-org/nannou). +- Enrich [examples](/examples/) with nice patches and add also examples with [bevy](https://bevyengine.org/) and [nannou](https://github.com/nannou-org/nannou). ## Support diff --git a/examples/README.md b/examples/README.md index 244203d..e48c551 100644 --- a/examples/README.md +++ b/examples/README.md @@ -26,4 +26,4 @@ Here is an example to mess around: cargo run --example with_nannou ``` -Please also check the [tests](/tree/main/tests/) folder if you'd like to explore example like code. +Please also check the [tests](/tests/) folder if you'd like to explore example like code.