Browse Source

Add docs

github-actions
Garrit Franke 11 months ago
parent
commit
7d12bfe605
  1. 1
      .gitignore
  2. 6
      book.toml
  3. 5
      docs/SUMMARY.md
  4. 1
      docs/introduction/SUMMARY.md
  5. 15
      docs/introduction/installation.md
  6. 4
      docs/introduction/overview.md
  7. 3
      src/SUMMARY.md
  8. 1
      src/chapter_1.md

1
.gitignore

@ -1,3 +1,4 @@
target/
.vscode/
examples_out/
book/

6
book.toml

@ -0,0 +1,6 @@
[book]
authors = ["Garrit Franke"]
language = "en"
multilingual = false
src = "docs"
title = "The Sabre Programming Language"

5
docs/SUMMARY.md

@ -0,0 +1,5 @@
# Introduction
- [Introduction](./introduction/SUMMARY.md)
- [Overview](./introduction/overview.md)
- [Installation](./introduction/installation.md)

1
docs/introduction/SUMMARY.md

@ -0,0 +1 @@
# Introduction

15
docs/introduction/installation.md

@ -0,0 +1,15 @@
# Installation
## Git
The fastest way to get up and running is to clone the [repository](https://git.sr.ht/~garritfra/sabre) and run the following command:
```sh
cargo install --path .
```
> **Note:** An installation of the Rust programming language is needed to compile Sabre.
## Cargo
TODO

4
docs/introduction/overview.md

@ -0,0 +1,4 @@
# Overview
Sabre is a bullshit-free (©) programming language that gets out of your way.
It is meant to "just work", without adding unnecessary and bloated language features.

3
src/SUMMARY.md

@ -0,0 +1,3 @@
# Summary
- [Chapter 1](./chapter_1.md)

1
src/chapter_1.md

@ -0,0 +1 @@
# Chapter 1
Loading…
Cancel
Save