Skip to content

Update README with Hemlang project information #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nbeerbower wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README with Hemlang project information #280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Hemlock is a systems scripting language that combines the power of C with the er

## Documentation

For the complete language manual and documentation, visit **[hem-doc](https://github.com/hemlang/hem-doc)**.
For the complete language manual and documentation, visit **[hemlang.dev](https://hemlang.dev)**.

## Design Philosophy

Expand Down Expand Up @@ -107,9 +107,9 @@ make test # Run all tests

### Install

**Quick Install (recommended):**
**One-Line Install (recommended):**
```bash
curl -fsSL https://raw.githubusercontent.com/hemlang/hemlock/main/install.sh | bash
curl -fsSL https://hemlang.dev/install.sh | bash
```

**From source:**
Expand All @@ -121,12 +121,29 @@ sudo make uninstall # Remove installation

## Running Programs

Hemlock provides two backends: an interpreter (`hemlock`) for rapid development and a compiler (`hemlockc`) for production deployment.

### Interpreter

```bash
./hemlock program.hml # Run a program
./hemlock program.hml arg1 arg2 # With arguments
./hemlock # Start REPL
```

### Compiler

The compiler generates optimized C code and produces native executables:

```bash
./hemlockc program.hml -o program # Compile to native executable
./hemlockc --check program.hml # Type check only
./hemlockc --strict-types prog.hml # Warn on implicit 'any' types
./program # Run compiled binary
```

The compiler includes **compile-time type checking** (enabled by default) and produces binaries with identical behavior to the interpreter.

## Bundling & Packaging

Hemlock provides tools to bundle multi-file projects and create self-contained executables.
Expand Down Expand Up @@ -155,6 +172,19 @@ The packaged executable runs anywhere without needing Hemlock installed.

See [Bundling & Packaging](docs/advanced/bundling-packaging.md) for details.

## Package Manager

[**hpm**](https://github.com/hemlang/hpm) is Hemlock's package manager with a GitHub-based registry:

```bash
hpm init # Initialize a new project
hpm add username/package # Add a dependency
hpm install # Install all dependencies
hpm publish # Publish to the registry
```

Packages are hosted directly on GitHub, making it easy to share and discover Hemlock libraries.

## Project Status

Hemlock v1.6.7 is released with:
Expand Down
Loading