roc-lang/roc
1
1
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2024-11-12 23:50:20 +03:00
Code Issues Packages Projects Releases Wiki Activity

improved editor README

Browse Source
This commit is contained in:
Anton-4 2021-04-24 11:58:37 +02:00
parent e91e21e4c7
commit f245655f42
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
editor/README.md
View File

@ -1,10 +1,11 @@
The editor is a work in progress, only a limited subset of Roc expressions are currently supported. New features are added every week!
Unlike most editors, we use projectional or structural editing to edit the [Abstract Syntax Tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree) directly. This will allow for cool features like excellent auto-complete and refactoring.
## Getting started
- Install the compiler, see [here](../BUILDING_FROM_SOURCE)
- On ubuntu run the following to make the clipboard work:
```
sudo apt install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
```
- Install the compiler, see [here](../BUILDING_FROM_SOURCE).
- Run the following from the roc folder:
```
@ -13,10 +14,14 @@ cargo run edit
## Troubleshooting
If you encounter an error like `gfx_backend_vulkan ... Failed to detect any valid GPUs in the current config ...` make sure the correct graphics card drivers are installed. On ubuntu `sudo ubuntu-drivers autoinstall` can resolve the problem.
If you encounter problems with integrated graphics hardware, install `mesa-vulkan-drivers` and `vulkan-tools`.
If you encounter an error like `gfx_backend_vulkan ... Failed to detect any valid GPUs in the current config ...` make sure the correct graphics card drivers are installed. On ubuntu `sudo ubuntu-drivers autoinstall` can resolve the problem.
If the error persists, take a look [here](https://www.techpowerup.com/gpu-specs/) to see if your GPU supports vulkan.
Use of OpenGL instead of vulkan should be available in several months.
Make sure to [create an issue](https://github.com/rtfeldman/roc/issues/new/choose) if you encounter any problems not listed above.
## Inspiration
We thank the following open source projects in particular for inspiring us when designing the Roc editor: