Skip to content
This repository has been archived by the owner on Jul 14, 2024. It is now read-only.

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Virtlink committed May 29, 2024
1 parent 6ad770a commit a559fa0
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 22 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,29 @@ This repository contains projects for managing Spoofax 3 dependencies.


## Platform
The `org.metaborg.spoofax3:platform` package is meant to be used by consumers of Spoofax 3 dependencies. The platform aligns Spoofax 3 dependencies that work together.
The Spoofax 3 platform specifies the versions of Spoofax dependencies that are known to work together. The `org.metaborg.spoofax3:platform` package is meant to be used by consumers of Spoofax 3 dependencies. To depend on this platform, specify in your `build.gradle.kts`:

```kotlin
dependencies {
implementation(platform("org.metaborg.spoofax3:platform:<version>"))
}
```


## Catalog
The `org.metaborg.spoofax3:catalog` package is meant to be used internally within Spoofax 3 projects, to align the versions of the third-party dependencies that are used.
The Spoofax 3 catalog specifies the versions of dependencies within the projects that constitute Spoofax 3 itself.
The `org.metaborg.spoofax3:catalog` package is meant to be used internally within Spoofax 3 projects. To use this catalog, specify in your `settings.gradle.kts`:

```kotlin
dependencyResolutionManagement {
versionCatalogs {
create("libs") {
from("org.metaborg.spoofax3:catalog")
}
}
}
```



## License
Expand Down
12 changes: 0 additions & 12 deletions catalog/README.md

This file was deleted.

8 changes: 0 additions & 8 deletions platform/README.md

This file was deleted.

0 comments on commit a559fa0

Please sign in to comment.