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

Commit

Permalink
Add develop documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Virtlink committed Jul 6, 2024
1 parent 549ed19 commit c1abde5
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/content/develop/adding-dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Adding Dependencies"
---
# Adding Dependencies
To add a dependency:

1. Modify the `gradle/libs.versions.toml` file and add the dependency to the correct section (or create a new section).\
Consult the [Gradle documentation](https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format) for more information on the `libs.versions.toml` file format.
2. Also mention the dependency in `example/build.gradle.kts`.
3. If the dependency is a Spoofax dependency (a library, application, or language that is part of Spoofax), also add the dependency to `platform/build.gradle.kts`.

7 changes: 7 additions & 0 deletions docs/content/develop/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Develop"
---
# Develop
Development information.

- [Adding dependencies](./adding-dependencies.md)
3 changes: 3 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ edit_uri: https://github.com/metaborg/gitonium/edit/main/docs
nav:
- Home:
- index.md
- Develop:
- develop/index.md
- develop/adding-dependencies.md

theme:
name: material
Expand Down

0 comments on commit c1abde5

Please sign in to comment.