Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
benKacimi committed Mar 21, 2024
1 parent b7e53a9 commit 2f4bd30
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,25 @@ Main caracteristics :
* It's a procedural programming language (no object, no structure)
* It has been simplified to the extreme without conditionnal instruction (if, then, else...), whithout loop instruction (for, do, while...), without arithmetical operation (+, -, *, /, %...)
* The learning takes place almost instantaneously
* 0 compilation error, 0 execution error ! (that's not a promise but an intention - feel free to contact me if you find an issue)
* It came with a set of core behavior and the model allow to add your own custom funtions.
* 0 compilation error, 0 execution error ! (that's not a promise but an intention - feel free to contact me if you find any issue)
* It came with a set of core behavior and the model allow to add your own custom functions.

So why this name ? Rusteek ? Basic was already taken, Robust was OK but a bit too pretentious so I throught rustic was a perfect definition of this project (move rustic to rusteek because it was the only rustic variation available)
So why this name ? Rusteek ? *Basic* was already taken, *Robust* was OK but a bit too pretentious, so I throught rustic was a perfect definition of this project (move rustic to rusteek because it was the only rustic variation available)

## What does it do ?
Rusteek will help you if you had to display a sentence containing data stored somewhere and data resulting from processing.
Let's take the BMI usecase (body mass index) to illustrate what can be done with Rusteek.
The BMI is calculated with your height (H) and your weight (W) and the formula is : BMI = W / (H*H)
That said, our need is to display the sentence :

"Hello ! your weight : **[WEIGHT]** kg, your height : **[HEIGHT]** meter so your BMI is **[BMI CALCULATION]**"
> "Hello ! your weight : **[WEIGHT]** kg, your height : **[HEIGHT]** meter so your BMI is **[BMI CALCULATION]**"
[WEIGHT], [HEIGHT] are variables which we assume pre-exist somewhere and are accessible to us\
[BMI CALCULATION] is the result of a calculation that take [WEIGHT] and [HEIGHT] as input.

In Rusteek, the sentence would be writtent like this :

> Hello **$'{'name}**, your weight : ${weight} means we dont know the value of tjhe
Hello ${server.name} your weight : ${weight} kg, your height : **${height}** meter so your BMI is **@calculateBMI(${weight}, ${height})**
> Hello ! your weight : **${weight}** kg, your height : **${height}** meter so your BMI is **@calculateBMI**(**${weight}**, **${height}**)
### Variable
In the world of "Configuration software" you can find a lot of tools to manage "placeholder".
Expand All @@ -35,16 +33,10 @@ Exemple : <http://${server.name}/uri>

In this exemple, we want to set a value for the "server.name" parameter but as this may depend on a number of factor, we dont know yet this value. We use the special syntax - ${...} - to indicate that it is a VARIALBLE that must be replaced at the right time and in the right context.

That's pretty classic and if you're already familiar with the placeholder principle, good news : Ruteek work exactly the same. We won't talk about a Placeholder but about a Variable instead.

That's pretty classic and if you're already familiar with the placeholder principle, good news : Rusteek work exactly the same. We won't talk about a Placeholder but about a Variable instead.


of caracters **${server.name}** means we dont know the value of tjhe

Exemple : @aFunction(${aVar})aTexte
In this exemple the analysze (tockenizer or lexer) that the instruction is composed in 2 parts :
- a function named a Function that take one parameter. The parameter in this case is a variable named aVar
- a literal (aText

## Authors
- [ben kacimi](https://github.com/benKacimi)
Expand Down

0 comments on commit 2f4bd30

Please sign in to comment.