Skip to content

Latest commit

 

History

History
170 lines (129 loc) · 3.76 KB

getting-started.md

File metadata and controls

170 lines (129 loc) · 3.76 KB

Getting Started with HyperMatrix

Welcome to HyperMatrix, a high-level programming language designed to combine simplicity, flexibility, and innovation. This guide will help you install HyperMatrix and learn how to use its commands effectively.

Installation

Step 1: Download the Installer

  1. Go to the Releases section of the HyperMatrix repository.
  2. Download the appropriate installer for your operating system.

Step 2: Run the Installer

  1. Run the downloaded installer file.
  2. Follow the on-screen instructions to complete the installation.

Once installed, you can use the hmatrix command in your terminal.

Using the hmatrix Command

The hmatrix command is the main way to execute HyperMatrix programs and access its interactive features. Below are the different ways to use it:

1. Run a File

Execute a HyperMatrix file with or without arguments:

hmatrix <path-to-file> <args>

Example:

hmatrix hello-world.hm

2. Interactive Mode

Start an interactive session to experiment with code:

hmatrix

This opens an empty interactive session where you can:

  • Define variables.
  • Execute code snippets.
  • Test small programs.

3. Continue Mode

Run a file and stay in interactive mode after it finishes execution:

hmatrix -continue <path-to-file>

While in continue mode, you can:

  • Access variables defined in the file.
  • Execute additional code.
  • Run other files using the run command.

Example:

hmatrix -continue demo-file.hm

After the file executes, you can:

> println(myVar); // Access a variable defined in the file
> run another-file.hm; // Run another file

4. Setup a Project

Initialize a new HyperMatrix project in the current or specified directory:

hmatrix -setup
hmatrix -setup:<path>

This creates a project structure and exits after setup is complete.

Example:

hmatrix -setup:/path/to/project

5. Attach a Library Folder

Attach a library folder for the current run:

hmatrix -lib:<path> <file>

Example:

hmatrix -lib:/path/to/lib hello-world.hm

6. Attach Settings or Resources

Settings

Attach a settings file for the current run (requires lexer updates for full functionality):

hmatrix -settings:<path> <file>

Resources

Attach resource files for the current run:

hmatrix -resource:<path> <file>

Example:

hmatrix -resource:/path/to/resources hello-world.hm

7. Retrieve Grammar or Version Information

Use the -help, -grammar, and -version flags for reference documentation:

  • -help → Displays a basic usage guide.
  • -grammar → Retrieves the full grammar file.
  • -version → Shows version details (highest priority, overrides all other flags).

Example:

hmatrix -help
hmatrix -grammar
hmatrix -version

Writing Your First Program

  1. Create a file named hello-world.hm:

    println("Hello, World!");

  2. Run the file using the hmatrix command:

    hmatrix hello-world.hm

  3. Expected output:

    Hello, World!

Exploring Examples

HyperMatrix comes with several example programs to demonstrate its features. You can find them in the examples/ directory:

  • hello-world.hm: A basic Hello World program.
  • paint-heart.hm: Drawing a heart in Windows 11 Paint.

Run these examples using:

hmatrix <path-to-example>

Getting Help

If you encounter issues or have questions:

  • Refer to the documentation files in the docs/ directory.
  • Open an issue on the GitHub repository.

Thank you for using HyperMatrix! We’re excited to see what you create.