docs: Add an initial README outlining instructions for project setup and linting tasks. (#10)

Author: Bill-hbrhbr

README.md

@@ -0,0 +1,38 @@
+ystdlib-cpp
+===================================
+An open-source C++ library developed and used at YScope.
+
+# Contributing
+Follow the steps below to develop and contribute to the project.
+
+## Requirements
+* Python 3.10 or higher
+* [Task] 3.40.0 or higher
+
+## Set up
+Initialize and update submodules:
+```shell
+git submodule update --init --recursive
+```
+
+## Linting
+Before submitting a pull request, ensure you’ve run the linting commands below and have fixed all
+violations and suppressed all warnings.
+
+To run all linting checks:
+```shell
+task lint:check
+```
+
+To run all linting checks AND fix some violations:
+```shell
+task lint:fix
+```
+
+To see how to run a subset of linters for a specific file type:
+```shell
+task -a
+```
+Look for all tasks under the `lint` namespace (identified by the `lint:` prefix).
+
+[Task]: https://taskfile.dev

taskfile.yaml

@@ -9,6 +9,7 @@ vars:
 
 tasks:
   clean:
+    desc: "Removes the project build directory."
     cmds:
       - "rm -rf '{{.G_BUILD_DIR}}'"
 

taskfiles/lint-yaml.yaml

@@ -5,6 +5,7 @@ tasks:
     aliases:
       - "yaml-check"
       - "yaml-fix"
+    desc: "Runs the YAML linters. Only checks for warnings and violations."
     deps:
       - "venv"
     dir: "{{.ROOT_DIR}}"

taskfiles/lint.yaml

@@ -11,10 +11,12 @@ vars:
 
 tasks:
   check:
+    desc: "Runs the full suite of linters to identify warnings and violations."
     cmds:
       - task: "yaml-check"
 
   fix:
+    desc: "Runs the full suite of linters and fixes some violations."
     cmds:
       - task: "yaml-fix"