diff --git a/.gitignore b/.gitignore index 8a7eace..3666d86 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ target/ .vscode/ examples_out/ +book/ \ No newline at end of file diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..ab1d47a --- /dev/null +++ b/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Garrit Franke"] +language = "en" +multilingual = false +src = "docs" +title = "The Sabre Programming Language" diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..09dcade --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,5 @@ +# Introduction + +- [Introduction](./introduction/SUMMARY.md) + - [Overview](./introduction/overview.md) + - [Installation](./introduction/installation.md) diff --git a/docs/introduction/SUMMARY.md b/docs/introduction/SUMMARY.md new file mode 100644 index 0000000..e10b99d --- /dev/null +++ b/docs/introduction/SUMMARY.md @@ -0,0 +1 @@ +# Introduction diff --git a/docs/introduction/installation.md b/docs/introduction/installation.md new file mode 100644 index 0000000..55b85e5 --- /dev/null +++ b/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 diff --git a/docs/introduction/overview.md b/docs/introduction/overview.md new file mode 100644 index 0000000..1553161 --- /dev/null +++ b/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. diff --git a/src/SUMMARY.md b/src/SUMMARY.md new file mode 100644 index 0000000..7390c82 --- /dev/null +++ b/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Chapter 1](./chapter_1.md) diff --git a/src/chapter_1.md b/src/chapter_1.md new file mode 100644 index 0000000..b743fda --- /dev/null +++ b/src/chapter_1.md @@ -0,0 +1 @@ +# Chapter 1