Skip to content

Commit

Permalink
Merge pull request #18 from BlacRyu/relative-links
Browse files Browse the repository at this point in the history
Fix broken readme links and make links relative
  • Loading branch information
alisomay authored Dec 4, 2023
2 parents a58aa3c + 1405fc5 commit 86e58d1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](/tests/) and enriched with various [examples](/examples/) to get you started right away.

Now let's make some sound! 🔔

Expand Down Expand Up @@ -138,15 +138,15 @@ 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](/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](/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/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

Expand All @@ -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](/examples/) with nice patches and add also examples with [bevy](https://bevyengine.org/) and [nannou](https://github.com/nannou-org/nannou).

## Support

Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](/tests/) folder if you'd like to explore example like code.

0 comments on commit 86e58d1

Please sign in to comment.