okto/README.md

73 lines
2.8 KiB
Markdown
Raw Normal View History

2025-01-11 14:53:34 +11:00
![Okto programming language logo](https://git.maxwellj.xyz/repo-avatars/051ee58b3e6ca69fa4057c945d2ae46e6749c607092e93f5679bd8c6d338b1bc)
2024-12-28 17:42:08 +11:00
# oktolang - A silly little programming language
## What is Okto?
Okto is an interpreted programming language written in C++. It's a strongly typed language which tells you exactly where you messed up if there's an error. Both a REPL and file input are supported.
## Why is Okto?
No reason.
Maybe one day the NodeJS community will find it and obsess over it in it's unoptimisedness. But that remains to be seen.
## How do I Okto?
First, download the source code and your favourite C++ compiler. Next, clone the repo (`git clone https://git.maxwellj.xyz/max/okto`) and CD into it. Compile the code (if the GCC is your poison, `g++ src/okto -o okto`) and run the binary.
Now we can start writing our code!
### The Basics of Okto
#### Syntax
Okto's syntax is still developing, and may change at any time. So if you update and your code breaks, check back here.
Functions usually work like this:
`functionName arg1 arg2 arg3`
A bit like Python 2 or shell.
Some built in functions include:
2025-01-05 14:32:26 +11:00
`log`: Log something to the console. Usage: `log (string, decimal, integer)` Example: `log "Hello, World!"`
2024-12-28 17:42:08 +11:00
`type`: Check the type of something. If it doesn't have a type, it's unknown. Usage: `type (function, variable, string, decimal, integer, incrementor, modifier, operator, comparitor, equals)` Example: `type 432`
2025-01-05 14:32:26 +11:00
`run`: Run a command on the system. May not work on every OS. Usage: `run (string)`
`exit`: Exit the program. Usage: `exit (integer)`
2024-12-28 17:42:08 +11:00
Okto is strongly typed, which means we need to learn about all the different types in the language! At present there are three types in Okto: strings, integers and decimals. Defining variables uses a C/C++ like syntax.
#### Strings
Strings are a bunch of letters enclosed in double quotes, like `"this"`.
Define a string in Okto with `str myString = "Hello World!"`
#### Integers
Integers are whole numbers, like `7`.
Define an integer in Okto with `int myInteger = 7`
#### Decimals
Decimals are non-whole numbers, like `3.14159`.
2024-12-28 18:16:12 +11:00
Define a decimal in Okto with `dec myDecimal = 3.14159`
2025-01-05 14:32:26 +11:00
#### Using variables
Use variables in your code like `$variable`, but replace variable with your actual variable's name. Make sure to use correct types in places! Incorporate a variable inside a string with `"${variable}"`
2024-12-28 18:16:12 +11:00
#### Updating Variables
Right now only integers and decimals can be changed. I'll refer to these as numbers.
Increment numbers with `myVariable ++` and decrement with `myVariable --`.
2025-01-05 14:32:26 +11:00
Add stuff together in number variables with `myVariable = $myOtherVariable + 7`. You can also subtract, multiply and divide with -, * and / respectively. For now you can't math outside of variables as it's still a prototype feature.