You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+10-13
Original file line number
Diff line number
Diff line change
@@ -4,23 +4,20 @@ Raven is an experimental language bringing modern features to every platform.
4
4
5
5
Raven's goal is to allow one codebase to run on every platform, without having to sacrifice speed or usability.
6
6
7
-
Currently, Raven mainly targets desktop applications, but web, mobile, and JVM targets are planned.
7
+
Currently, Raven targets desktop applications, but web, mobile, and JVM targets are planned.
8
8
9
-
# !!! DO NOT DOWNLOAD RAVEN ANYWHERE WITH A SPACE IN THE PATH. EX: "C:/Program Files/Raven". IT WILL NOT WORK. I CANNOT FIX IT !!!
9
+
# Installing
10
10
11
-
# Building
11
+
For help on installing Raven, look at the [first chapter of the Raven book](docs/raven/1_installation.md)
12
12
13
-
Requires LLVM set with the environmental variable LLVM_SYS_130_PREFIX = (path to folder with bin)
13
+
# Contributing
14
14
15
-
Please download LLVM from https://github.com/PLC-lang/llvm-package-windows/releases/tag/v13.0.0
15
+
If your interested in contributing, look at [the current Raven projects](projects.md).
16
+
More information can be found in the [building.md file](docs/building.md)
16
17
17
-
C++ is also required to be installed somewhere on your system, for Windows get it from https://visualstudio.microsoft.com/vs/community/
18
+
Please read the [contributing guidelines](contributing.md) before contributing.
18
19
19
-
Nightly is required for building the compiler, you can set the project to nightly with ```rustup override set nightly```
20
+
# Documentation
21
+
For the documentation on the Raven language, look at the [Raven book in the raven folder](raven/raven.md)
20
22
21
-
# Running
22
-
23
-
Run this in the lib/test folder (or whatever Raven project in the repository you want to run)
24
-
```cargo run --bin magpie```
25
-
26
-
That command will build and run Raven's CLI with the following options
23
+
For crate-level, file-level, and function-level documentation over the Raven internals, look at the source itself in the language folder. You can also find a helpful document going over internals in [language/README.md](language/README.md)
This repository is under the MIT License. By contributing to this project, any contributions you make are also under the MIT License.
6
+
The full license terms are in the LICENSE file. The license simply allows free copying, distribution, modification, publishing, sublicensing, merging, or selling your code.
7
+
Basically, you have no right to prevent others from doing whatever they want with the code.
8
+
However, the license also prevents you from taking any responsibility over how the code is used, and you are not liable for any damage cuased.
9
+
10
+
# Contributors
11
+
12
+
All contributors without direct write access must make contributions to their own forks and open a pull request for code review.
13
+
14
+
All contributions will automatically be checked by the CI. This will let you know if anything is broken, but you should test all code you write.
15
+
16
+
# Style
17
+
18
+
The repository follows the Rust style, with:
19
+
- snake_case method, file, variable, and folder names
20
+
- CamelCase structure names
21
+
22
+
When in doubt, follow the established code style found in the source.
This folder contains all the documentation over the Raven project and everything associated with Raven.
4
+
5
+
If your interested in contributing, look at [the current Raven projects](projects.md).
6
+
7
+
For the documentation on the Raven language, look at the [Raven book in the raven folder](raven/raven.md)
8
+
9
+
Please read the [contributing guidelines](contributing.md) before contributing.
10
+
11
+
For crate-level, file-level, and function-level documentation over the Raven internals, look at the source itself in the language folder. You can also find a helpful document going over internals in [language/README.md](../language/README.md)
The core is the base compiler of Raven (written in Rust), most work is fixing issues with the language itself and adding new features.
3
+
4
+
This is in the language folder of the base repository
5
+
6
+
# Magpie
7
+
Magpie is Raven's build tool, dependency manager, and version control. It is currently lacking most functionality.
8
+
9
+
This is in the tools/magpie folder of the base repository
10
+
11
+
# IDE Extensions / Raven Language Server
12
+
This provides support to various IDEs such as VSCode and implementing features like syntax highlighting. It's a mix of Rust (Raven Language Server), NodeJS (VSCode), and Java (IntelliJ)
13
+
14
+
This is in the tools/ide-plugins folder of the base repository
15
+
16
+
# Website
17
+
This is the main page for Raven.
18
+
19
+
The source is in the website folder of the base repository The website is on the gh-pages branch of the base repository
20
+
21
+
# Standard Library
22
+
This is the standard library of Raven for every platform it supports. It's divided into a platform-specific std, and a universal std, which calls the platform std.
0 commit comments