diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index ad5aa60..d92cfd8 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -4,9 +4,14 @@ on: push: branches: - master + paths-ignore: + - '**/*.md' pull_request: branches: - master + paths-ignore: + - '**/*.md' + workflow_dispatch: # Manually trigger the workflow from the GitHub Actions UI jobs: diff --git a/markdown/introduction.md b/markdown/introduction.md index e7fa636..a44f07e 100644 --- a/markdown/introduction.md +++ b/markdown/introduction.md @@ -1,2 +1,6 @@ # Introduction -RueI is a hint framework for scp:sl. +RueI is a hint framework for scp:sl. the primary component of RueI is the ability to display multiple hints at once, but it also provides a lot of other features to make working with hints easier and more effective. + +a quick note: RueI is licensed under CC0 1.0. this means you can do *whatever* you want with both its compiled versions and its source code. commerical use, modifications, etc, are all okay! + +RueI is a **dependency**. it is a not a plugin. this means that it does not provide any functionality out of the box. other plugins will not work automatically once you install this if they do not have built-in support for RueI.