Note

This repository has been archived. The Wiki documentation is now integrated into the compiler repository.

Boriel Basic Documentation

Welcome to the Boriel Basic documentation repository. This repository contains the documentation for the Boriel Basic compiler, an open-source project designed to compile BASIC code for the ZX Spectrum.

Table of Contents

• Introduction
• Getting Started
• Documentation Structure
• Contributing
• License

Introduction

Boriel Basic is an open-source BASIC compiler aimed at ZX Spectrum users. It allows developers to write BASIC programs that can be compiled into efficient machine code, providing both ease of use and performance.

For more information about the Boriel Basic compiler, visit the main repository.

Getting Started

To get started with Boriel Basic, follow these steps:

1. Clone the repository:

   git clone https://github.com/boriel-basic/docs.git

2. Navigate to the project directory:

   cd docs

Create or edit a .md (Markdown) document of your choice, and push your changes to a local branch as described in Contributing

Documentation Structure

The documentation is organized as follows:

• Introduction: Overview of the Boriel Basic compiler.
• Installation: Step-by-step guide to installing the compiler.
• Usage: Instructions on how to use the compiler.
• Examples: Sample projects and code snippets.

Contributing

We welcome contributions from the community. To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Make your changes.
4. Submit a pull request.

Please read our contributing guidelines before submitting your changes.

License

This project is licensed under the Creative Commons Attribution 4.0 International License. See the LICENSE file for details.

---

For any questions or support, feel free to open an issue in this repository.