Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@TodePond
TodePond authored May 17, 2024
1 parent e2faa1f commit a24b8e1
Showing 1 changed file with 39 additions and 42 deletions.
81 changes: 39 additions & 42 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ If you're reading this then you might be looking for the hidden examples page...
CONGRATULATIONS! You found it!
Here it is: https://github.com/TodePond/DreamBerd/blob/main/res/res/Examples.md
todepond woz here
-->

> **New:** [DreamBerd now supports rich text](https://github.com/TodePond/DreamBerd/releases/tag/v£.££)
Expand Down Expand Up @@ -199,17 +197,16 @@ print(1 + 2*3)! //7
print(1+2 * 3)! //9
```

Unlike some other languages, DreamBerd allows you to use the caret (^) for exponentiation.
DreamBerd proudly supports fractions!

```java
print(1^1)! // 1
print(2^3)! // 8
const const half = 1/2!
```

You can also use the number name, for example:
You can also use number names.

```java
print(one+two)! //3
print(one + two)! //3
```

## Indents
Expand Down Expand Up @@ -266,20 +263,20 @@ If you want to be much less precise, you can use `=`.
To declare a function, you can use any letters from the word `function` (as long as they're in order):

```java
function add (a, b) => a + b!
func multiply (a, b) => a * b!
fun subtract (a, b) => a - b!
fn divide (a, b) => a / b!
functi power (a, b) => a ^ b!
union inverse (a) => 1/a!
function add(a, b) => a + b!
func multiply(a, b) => a * b!
fun subtract(a, b) => a - b!
fn divide(a, b) => a / b!
functi power(a, b) => a ^ b!
f inverse(a) => 1/a!
```

## Dividing by Zero

Dividing by zero returns `undefined`.

```java
print(3 / 0)! // undefined
print(3 / 0)! //undefined
```

## Strings
Expand Down Expand Up @@ -328,7 +325,7 @@ print("Hello {name}€!")!
```

The symbol for the Cape Verdean escudo is placed in the decimal separator position, as in 2$50.
Developers from the Republic of Cape Verde can benefit from this syntax:
Developers from the Republic of Cape Verde can benefit from this syntax.

```java
const const player = { name: "Lu" }!
Expand All @@ -355,7 +352,7 @@ Similarly, integers are just arrays of digits.
Int == Digit[]!
```

If you want to use a binary representation for integers, `Int9` and `Int99` types are also available.
In case you want to use a binary representation for integers, `Int9` and `Int99` types are also available.

```java
const var age: Int9 = 28!
Expand All @@ -371,14 +368,13 @@ You can use the regular expression type to narrow string values.
const const email: RegExp<(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]|[0-4][0-9])|1[0-9][0-9]|[1-9]?[0-9])|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])> = "[email protected]"!
```

To avoid confusion, you can use any spelling that you want, such as 'Regex', 'RegularExpression' or even
'RegularExpress' if you like trains.
To avoid confusion, you can use any spelling that you want, such as `Regex`, `RegularExpression` and `RegExp`.

For simplicity, all supported regular expressions match the regular expression `/Reg(ular)?[eE]x(press(ion)?|p)?/`.
For simplicity, all supported regular expressions match the regular expression `/Reg(ular)?[eE]x(press|p)?/`.

## Previous

The `previous` keyword lets you see into the past!<br>
The `previous` keyword lets you see into the past.<br>
Use it to get the previous value of a variable.

```java
Expand All @@ -388,15 +384,15 @@ print(score)! //6
print(previous score)! //5
```

Similarly, the `next` keyword lets you see into the future!
Similarly, the `next` keyword lets you see into the future.

```java
const var score = 5!
addEventListener("click", () => score++)!
print(await next score)! //6 (when you click)
```

Additionally, the `current` keyword lets you see into the present!!
Additionally, the `current` keyword lets you see into the present.

```java
const var score = 5!
Expand Down Expand Up @@ -459,7 +455,7 @@ const var player1 = new Player()!
const var player2 = new Player()! //Error: Can't have more than one 'Player' instance!
```

This is how you could do this:
This is how you could do it instead.

```java
class PlayerMaker {
Expand All @@ -485,7 +481,7 @@ Use `Date.now()` to get the current date and time.
Date.now()!
```

By the way, you can set the time.<br>
You can set the time.<br>

```java
// Move the clocks back one hour
Expand Down Expand Up @@ -538,7 +534,7 @@ const const name = "Lu or Luke (either is fine)"!!!!!!!!!
print(name)! // "Lu or Luke (either is fine)"
```

Similarly, you can use an inverted exclamation mark for negative priority.
In the same spirit, you can use an inverted exclamation mark for negative priority.

```java
const const name = "Lu"!
Expand All @@ -556,7 +552,7 @@ const const iAge = 29!
const const bHappy = true!
```

**New for 2023:** You can now make globals.
**New for 2023:** You can now make globals!

```java
const const g_fScore = 4.5!
Expand All @@ -575,7 +571,7 @@ reverse!

## Class Names

For maximum compatibility with other languages, you can alternatively use the `className` keyword when making classes.
For maximum compatibility with other languages, you can also use the `className` keyword when making classes.

This makes things less complicated.

Expand All @@ -585,19 +581,19 @@ className Player {
}
```

In response to some recent criticism about this design decision, we would like to remind you that this is part of the JavaScript specification, and therefore - out of our control.
In response to some recent criticism about this design decision, we would like to remind you that this is part of the JavaScript specification, and therefore — out of our control.

## DBX

You can embed DBX in DreamBerd. It's just DreamBerd, and it's also just HTML.
You can embed DBX in DreamBerd. It's just DreamBerd. And it's also just HTML.

```java
funct App() => {
return <div>Hello world!</div>
}
```

**Warning:** As you know, `class` is already a keyword in DreamBerd, so you can't use it within DB3X.
**Warning:** As you know, `class` is already a keyword in DreamBerd, so you can't use it within DBX.

```java
funct App() => {
Expand All @@ -615,7 +611,7 @@ funct App() => {
}
```

Instead, you can use the `htmlClassName` attribute.
Instead, please use the `htmlClassName` attribute.

```java
funct App() => {
Expand All @@ -624,7 +620,7 @@ funct App() => {
}
```

**Please note:** Unlike JSX, you are free to freely use the `for` attribute - because DreamBerd doesn't have loops.
**Please note:** Unlike JSX, you are free to freely use the `for` attribute, because — in DreamBerd, there are no loops.

```java
funct App() => {
Expand Down Expand Up @@ -763,13 +759,13 @@ If you forget to finish your code, DreamBerd will auto-complete the whole thing!
print( // This is probably fine
```

**Please note:** AI does not use AI. Instead, any incomplete code will be auto-emailed to Lu Wilson, who will get back to you with a completed line as soon as possible.
**Please note:** AI does not use AI. Instead, any incomplete code will be auto-emailed to [Lu Wilson](https://todepond.com), who will get back to you with a completed line as soon as possible.

**Now recruiting:** The backlog of unfinished programs has now grown unsustainably long. If you would like to volunteer to help with AI, please write an incomplete DreamBerd program, and leave your contact details somewhere in the source code.

## Copilot

It's worth noting that Github Copilot doesn't understand DreamBerd, which means that Microsoft won't be able to steal your code.
It's worth noting that GitHub CoPilot doesn't understand DreamBerd, which means that MicroSoft won't be able to steal your code.
This is great for when you want to keep your open-sourced project closed-source.
Expand All @@ -780,9 +776,9 @@ Using the word 'DreamBerd' in your project name implies that the DreamBerd Found
However, **not** using the word 'DreamBerd' in your project implies that the DreamBerd Foundation **does** own your project. If you would like to keep ownership of your work, please always use the word 'DreamBerd' in it.
Here are some examples:<br>
✅ DreamBerdScript (not owned by the DreamBerd Foundation - you are free to use this name)<br>
❌ ECMAScript (owned by the DreamBerd Foundation - please consider renaming)<br>
❌ Rust Foundation (owned by the DreamBerd Foundation - please consider renaming)
✅ DreamBerdScript (not owned by the DreamBerd Foundation — you are free to use this name)<br>
❌ ECMAScript (owned by the DreamBerd Foundation — please consider renaming)<br>
❌ Rust Foundation (owned by the DreamBerd Foundation — please consider renaming)
## Contributing
Expand All @@ -805,11 +801,13 @@ If the compiler refuses at first, politely reassure it. For example:<br>
**Note:** As of 2023, the compiler is no longer functional due to the DreamBerd language being too advanced for the current state of AI.
**Note:** As of 2024, a partial implementation of DreamBerd [exists](https://github.com/vivaansinghvi07/dreamberd-interpreter/).
## Highlighting
Syntax highlighting is now available for DreamBerd in VSCode. To enable it, install a [highlighting extension](https://marketplace.visualstudio.com/items?itemName=fabiospampinato.vscode-highlight) and then use the [DreamBerd configuration file](https://github.com/TodePond/DreamBerd/blob/main/.vscode/settings.json).
This is what it looks like:
This is what the highlighting looks like:
```
const const name = "Luke"!
Expand All @@ -822,8 +820,7 @@ print(name)! // "Luke"
Wait, I almost forgot!
Parentheses in DreamBerd do nothing. They get replaced with whitespace.<br>
The following lines of code all do the same thing.
Parentheses in DreamBerd do nothing. They get replaced with whitespace. Everything is grouped via significant whitespace. The following lines of code all do the exact same thing.
```java
add(3, 2)!
Expand All @@ -832,7 +829,7 @@ add 3, 2!
add)3, 2(!
```
Lisp lovers will love this feature. Use as many parentheses as you want!
Lisp lovers will love this feature. Use as many parentheses as you want.
```java
(add (3, (add (5, 6))))!
Expand Down Expand Up @@ -860,4 +857,4 @@ For examples of DreamBerd in action, check out the [examples page](https://githu
![image](files/star-history.png)
DreamBerd was made with 💔 by Lu Wilson, creator of the [Game of Living](https://youtu.be/WMJ1H3Ai-qs).
DreamBerd was made with 💔 by [Lu Wilson](https://todepond.com), creator of the [Game of Living](https://youtu.be/WMJ1H3Ai-qs).

0 comments on commit a24b8e1

Please sign in to comment.