improved readme

[ascandone]

No description provided.

[coderabbitai]

Walkthrough

This change updates the README.md file by adding a new "Build locally" section. The section outlines how users can build the CLI from source using the Golang toolchain, with the command go install ./internal/numscript/numscript.go. It also mentions that users can alternatively download the CLI from the repository's releases page if they lack the toolchain.

Changes

File	Change Summary
README.md	Added a "Build locally" section with instructions for building the CLI using Golang (go install ./internal/numscript/numscript.go) and alternative download options.

Possibly related PRs

• chore: improved readme #42: Adjusts local development instructions in the README by moving them to CONTRIBUTING.md, directly related to the documentation changes.

Suggested reviewers

• flemzord

Poem

I’m a rabbit with a twitch and a hop,
Documenting changes ’til nothing stops.
A new guide to build our CLI from source,
With commands to run its magic force.
Hop along, code friends, never lose your pace!
🐇🎶
Happy coding in our speedy tech space!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 42f1133 and 9eed937.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

20-20: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🔇 Additional comments (1)

README.md (1)

19-23:

✅ Verification successful

Adjust the Heading Level for Consistency

The newly added "Build locally" section uses a third-level heading (### Build locally), but based on markdown guidelines and the static analysis hint (MD001), the heading level should only increment by one level at a time. Since the file already uses a top-level heading (# Numscript CLI), consider updating this section header to a second-level heading (## Build locally) for proper hierarchy.

-### Build locally
+## Build locally

---

Verified: Update the header level for consistency in README.md

• The file already has a top-level header (e.g., # Numscript CLI), so the "Build locally" section should indeed use a second-level header (## Build locally) rather than a third-level header.

• The following diff reflects the needed change:

  -### Build locally
  +## Build locally

This change aligns with MD001 guidelines ensuring that heading levels increment by one level at a time.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

20-20: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.60%. Comparing base (42f1133) to head (9eed937).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #47   +/-   ##
=======================================
  Coverage   63.60%   63.60%           
=======================================
  Files          31       31           
  Lines        7100     7100           
=======================================
  Hits         4516     4516           
  Misses       2375     2375           
  Partials      209      209           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.