Skip to content

Commit 3d18f34

Browse files
authored
Updated README
1 parent fdf8601 commit 3d18f34

1 file changed

Lines changed: 18 additions & 13 deletions

File tree

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@
1313

1414
[![build](https://github.com/PipeRift/rift/actions/workflows/build.yml/badge.svg)](https://github.com/PipeRift/rift/actions/workflows/build.yml) [![license](https://img.shields.io/github/license/PipeRift/rift?labelColor=394047)](https://github.com/PipeRift/rift/blob/main/LICENSE) [![Code Quality](https://api.codacy.com/project/badge/Grade/a377314fe8ae4a2bb17159bce8a1ac76)](https://app.codacy.com/gh/PipeRift/rift?utm_source=github.com&utm_medium=referral&utm_content=PipeRift/rift&utm_campaign=Badge_Grade)
1515

16+
> [!IMPORTANT]
17+
> Rift is a project in early development. At this time it is **not ready for general use**.
1618
17-
## [Documentation](https://riftlang.org)
18-
<br>
19+
# Fundamentals
1920

2021
## Code is Data
2122

@@ -25,16 +26,16 @@ Where in languages like C, C++ you write code into text directly, in Rift you us
2526
At first this might sound counterintuitive, but it actually brings multiple key advantages with huge potential for the developer and code quality.
2627

2728
### Coding style is User preference
28-
Code does not specify how your code looks, your settings in the editor do, and they are your choice.
29-
_You will always be comfortable in any code, because it is always the coding standard you prefer_
29+
Code does not specify how your code looks, your editor settings do, and they are your choice.
30+
Many programmers, many styles, same code.
3031

3132
### Many code representations, one language
3233
Rift has the concept of _"Views"_ which are different visualizations of code (E.g: Visual Nodes and Text).
3334

34-
This means developers can choose how to code, while on the **same language**, **same editor**, **same build system**, and **same compiler**. One example would be in the development of a game where a designer uses visual nodes and a programmer uses text, but they are both using the same environment. In the future, they could potentially even convert code between views.
35+
This means developers can choose how to code, while sharing the **same language**, **same editor**, **same build system** and **same compiler**. One example would be the development of a videogame where a designer uses visual nodes and a programmer uses text, but they both use the same environment.
3536

3637
### No include or definition order
37-
Since it is data we are talking about, theres no need for includes or order of functions or variables. Its all already there as soon as the project has loaded.
38+
No need for includes, no circular dependencies, no order of functions or variables.
3839

3940
## Compile times
4041

@@ -67,7 +68,10 @@ Some examples of what future modularity would look like:
6768
- E.g: A format checker that ensures correct naming across a module, even while compiling
6869

6970

70-
## Software Quality
71+
# [Documentation](https://riftlang.org)
72+
Visit [riftlang.org](https://riftlang.org) to read documentation on Rift.
73+
74+
# Software Quality
7175
[![build](https://github.com/PipeRift/rift/actions/workflows/build.yml/badge.svg)](https://github.com/PipeRift/rift/actions/workflows/build.yml) [![static-analysis](https://github.com/PipeRift/rift/actions/workflows/static-analysis.yml/badge.svg)](https://github.com/PipeRift/rift/actions/workflows/static-analysis.yml)
7276

7377
The code is validated on the following platforms/compilers:
@@ -79,28 +83,29 @@ The code is validated on the following platforms/compilers:
7983

8084
It has also been tested on **x64** and **ARM64** architectures.
8185

82-
## Credits
83-
Developed by Miguel Fernandez Arce (Muit) and every direct or indirect [contributors](https://github.com/piperift/rift/graphs/contributors) to the GitHub repository.
86+
# Credits
87+
Developed by Piperift and every direct or indirect [contributors](https://github.com/piperift/rift/graphs/contributors) to the GitHub repository.
8488

85-
## License
89+
# License
8690
Rift is licensed under the [LGPLv3](https://github.com/piperift/rift/blob/master/LICENSE) license with some exceptions.
8791

88-
### Why LGPL License?
92+
## Why LGPL License?
8993
Any Rift's source code licensed as [LGPLv3](https://github.com/piperift/rift/blob/master/LICENSE) seeks to defend the following:
9094
- Rift must remain free and distributable to and by everyone
9195
- Everyone can freely contribute and modify Rift
9296
- Rift can be used to learn
9397

9498
The GPL strictly aims at protecting these freedoms, requiring everyone to share their modifications when they also share the software in public. That aspect is commonly referred to as [Copyleft](http://en.wikipedia.org/wiki/Copyleft).
9599

96-
### Details
100+
## Details
97101
While Rift editor, compiler and other tools are under LGPL, other components/tools might be under more permissive licenses.
98102

99103
This also means code you created can be under any license. One example could be a custom compiler pass for optimization, or a new view that adds a new way to edit code.
100104

101105
Rift’s source can also be embedded into other projects (explaining the L of LGPL). This means projects embedding Rift do not need to inherit the same license and can be commercial, but Rift components must keep their own licenses and remain open source if LGPL, including any modifications to them.
102106

103-
### Your code
107+
## Your code
104108
Any code or assets you create with Rift as a language is of your sole property. This includes code files like .rf and any generated files by Rift compiler, editor or tools.
105109

106110
This means Rift can be used commercially by studios, programmers, designers, artists or anyone else.
111+

0 commit comments

Comments
 (0)