updated hyperlinks in readme

This commit is contained in:
MaxOhn
2024-04-03 15:31:04 +02:00
parent f0f08fe9c9
commit ab03b988e2
2 changed files with 29 additions and 29 deletions
Generated
+16 -16
View File
@@ -28,9 +28,9 @@ checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"
[[package]]
name = "indoc"
version = "2.0.4"
version = "2.0.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1e186cfbae8084e513daff4240b4797e342f988cecda4fb6c939150f96315fd8"
checksum = "b248f5224d1d606005e02c97f5aa4e88eeb230488bcc03bc9ca4d7991399f2b5"
[[package]]
name = "libc"
@@ -50,9 +50,9 @@ dependencies = [
[[package]]
name = "memoffset"
version = "0.9.0"
version = "0.9.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5a634b1c61a95585bd15607c6ab0c4e5b226e695ff2800ba0cdccddf208c406c"
checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
dependencies = [
"autocfg",
]
@@ -103,9 +103,9 @@ dependencies = [
[[package]]
name = "pyo3"
version = "0.21.0"
version = "0.21.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a02a88a17e74cadbc8ce77855e1d6c8ad0ab82901a4a9b5046bd01c1c0bd95cd"
checksum = "a7a8b1990bd018761768d5e608a13df8bd1ac5f678456e0f301bb93e5f3ea16b"
dependencies = [
"cfg-if",
"indoc",
@@ -121,9 +121,9 @@ dependencies = [
[[package]]
name = "pyo3-build-config"
version = "0.21.0"
version = "0.21.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a5eb0b6ecba38961f6f4bd6cd5906dfab3cd426ff37b2eed5771006aa31656f1"
checksum = "650dca34d463b6cdbdb02b1d71bfd6eb6b6816afc708faebb3bac1380ff4aef7"
dependencies = [
"once_cell",
"target-lexicon",
@@ -131,9 +131,9 @@ dependencies = [
[[package]]
name = "pyo3-ffi"
version = "0.21.0"
version = "0.21.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ba8a6e48a29b5d22e4fdaf132d8ba8d3203ee9f06362d48f244346902a594ec3"
checksum = "09a7da8fc04a8a2084909b59f29e1b8474decac98b951d77b80b26dc45f046ad"
dependencies = [
"libc",
"pyo3-build-config",
@@ -141,9 +141,9 @@ dependencies = [
[[package]]
name = "pyo3-macros"
version = "0.21.0"
version = "0.21.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4e80493c5965f94a747d0782a607b2328a4eea5391327b152b00e2f3b001cede"
checksum = "4b8a199fce11ebb28e3569387228836ea98110e43a804a530a9fd83ade36d513"
dependencies = [
"proc-macro2",
"pyo3-macros-backend",
@@ -153,9 +153,9 @@ dependencies = [
[[package]]
name = "pyo3-macros-backend"
version = "0.21.0"
version = "0.21.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fcd7d86f42004025200e12a6a8119bd878329e6fddef8178eaafa4e4b5906c5b"
checksum = "93fbbfd7eb553d10036513cb122b888dcd362a945a00b06c165f2ab480d4cc3b"
dependencies = [
"heck",
"proc-macro2",
@@ -219,9 +219,9 @@ checksum = "2fd0db749597d91ff862fd1d55ea87f7855a744a8425a64695b6fca237d1dad1"
[[package]]
name = "syn"
version = "2.0.53"
version = "2.0.58"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7383cd0e49fff4b6b90ca5670bfd3e9d6a733b3f90c686605aa7eec8c4996032"
checksum = "44cfb93f38070beee36b3fef7d4f5a16f27751d94b187b666a5cc5e9b0d30687"
dependencies = [
"proc-macro2",
"quote",
+13 -13
View File
@@ -8,21 +8,21 @@ As such, its performance is much faster than a native python library.
## Usage
The library exposes multiple classes:
- [`Beatmap`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L23-L101): Parsed `.osu` file
- [`GameMode`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L5-L13)
- [`Beatmap`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L23-L101): Parsed `.osu` file
- [`GameMode`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L5-L13)
- Calculators
- [`Difficulty`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L103-L251): Class to calculate difficulty attributes, strains, or create gradual calculators
- [`Performance`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L253-L439): Performance attributes calculator
- [`GradualDifficulty`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L441-L465): Calculator to calculate difficulty attributes after each hitobject
- [`GradualPerformance`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L467-L493): Calculator to calculator performance attributes after each hitresult
- [`BeatmapAttributesBuilder`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L495-L617): Beatmap attributes calculator
- [`Difficulty`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L103-L251): Class to calculate difficulty attributes, strains, or create gradual calculators
- [`Performance`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L253-L439): Performance attributes calculator
- [`GradualDifficulty`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L441-L465): Calculator to calculate difficulty attributes after each hitobject
- [`GradualPerformance`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L467-L493): Calculator to calculator performance attributes after each hitresult
- [`BeatmapAttributesBuilder`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L495-L617): Beatmap attributes calculator
- Results
- [`DifficultyAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L666-L853)
- [`Strains`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L928-L998): Strain values of a difficulty calculation, suitable to plot difficulty over time
- [`PerformanceAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L855-L926)
- [`BeatmapAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L1000-L1030)
- [`HitResultPriority`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L15-L21): Passed to `Performance`, decides whether specified accuracy should be realized through good or bad hitresults
- [`ScoreState`](https://github.com/MaxOhn/rosu-pp-py/blob/cefe495f1727bc53bc31507d0b3f077646019876/rosu_pp_py.pyi#L619-L664): Hitresults and max combo of a score, found in `PerformanceAttributes` and passed to gradual calculators
- [`DifficultyAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L666-L853)
- [`Strains`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L928-L998): Strain values of a difficulty calculation, suitable to plot difficulty over time
- [`PerformanceAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L855-L926)
- [`BeatmapAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L1000-L1030)
- [`HitResultPriority`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L15-L21): Passed to `Performance`, decides whether specified accuracy should be realized through good or bad hitresults
- [`ScoreState`](https://github.com/MaxOhn/rosu-pp-py/blob/f0f08fe9c9a94331840db67d5cf3b9b8cd15ea55/rosu_pp_py.pyi#L619-L664): Hitresults and max combo of a score, found in `PerformanceAttributes` and passed to gradual calculators
## Example