diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 5f848f2..568e4fe 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -19,7 +19,7 @@ repos: - id: gitleaks args: ["--verbose"] - repo: https://github.com/commitizen-tools/commitizen - rev: 3.8.2 + rev: 3.9.0 hooks: - id: commitizen - id: commitizen-branch diff --git a/.tool-versions b/.tool-versions index ee5e09c..56dab6e 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1,2 +1,4 @@ gitleaks 8.18.0 +hadolint 2.12.0 +pre-commit 3.4.0 task 3.30.0 diff --git a/README.md b/README.md index 13746f6..63c740a 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,20 @@ CPU mining can be profitable using algorithms such as: `RandomX`, `Cryptonight`

(back to top)

+## ➤ Getting Started + +To configure your system for the development of this project, follow the steps below: + +- Install [asdf](https://asdf-vm.com/) to manage runtime dependencies. +- Install runtime dependencies. + +```bash +cut -d' ' -f1 .tool-versions | xargs -I{} sh -c 'asdf plugin add "$1"' -- {} +asdf install +``` + +- Run task from the root of the repository to see available commands. We use task in place of make for this project. See [Taskfile.yml](Taskfile.yml) for more information. + ## ➤ Setup The preferred way to configure XMRig is using a configuration file in JSON format, because it is more flexible and easier to use. The CLI doesn't cover all the features available and can be a limiting factor, depending on the scenario.