index.md

Soplang Documentation

Soplang is the Somali programming language, designed to make programming accessible to Somali speakers worldwide.

Documentation Sections

Getting Started

• Installation Guide - Detailed instructions for installing Soplang on Windows, Linux, and macOS

Language Reference

• Keywords and Grammar - Complete reference of Soplang keywords and language structure
• Expressions - Detailed explanation of expressions and operator usage
• Grammar Specification - Formal grammar specification in EBNF

Examples

• Examples Guide - Guide to the example programs
• Test Examples - Documentation for test examples

Building and Performance

• Build Guide - How to build Soplang from source
• Performance - Performance benchmarks and optimization techniques
• C Implementation - Information about the C implementation

Testing

• Testing Guide - How to test Soplang
• Test README - Additional test documentation

Getting Started

Installation

To install Soplang, see the Installation Guide which covers all platforms:

• Windows installation (using installer or building from source)
• Linux installation (using package manager or building from source)
• macOS installation (using DMG or building from source)

Running Soplang

To run Soplang after installation, you can:

# Run a Soplang program
soplang examples/hello_world.so

# Start the interactive shell
soplang

If you haven't installed Soplang yet, you can run it directly from the source:

python main.py examples/hello_world.so

Or start the interactive shell:

python main.py

Further Resources

• Website: https://www.soplang.org/
• GitHub Repository: https://github.com/sharafdin/soplang