Skip to content

Commit 03465e4

Browse files
committed
Update readme, release 1.0
1 parent 4da89de commit 03465e4

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1+
> [!CAUTION]
2+
> Bread is only for linux, there are no plans to port it to windows or macos
3+
4+
15
# bread
26
The bread programming language
7+
8+
## What is bread?
9+
Bread is a custom programming language, built to compile to C++
10+
11+
## How 2 use
12+
Documentation can be found at `docs/COMMANDS.md`
13+
Examples can be found in the examples folder.
14+
To compile your `.bread` program, run the executable with your filename as the argument and a compiled version should appear in your folder with the same name!
15+
16+
317
## What are the branches for?
4-
fs - Active development branch, implementation of filesystem versions. Code pushed here may not work.
18+
fs - Experimental features branch. Code pushed here may not work.
519

620
main - The main branch, used when not implementing a major new function. Code pushed here works.

0 commit comments

Comments
 (0)