Skip to content

Commit a4c5f2e

Browse files
mkaputintegraledelebesgueArcticae
authored
Add README.md (#38)
Signed-off-by: Marek Kaput <marek.kaput@outlook.com> Co-authored-by: Jan Smółka <jp.smolka@gmail.com> Co-authored-by: Tomasz Rejowski <34059895+Arcticae@users.noreply.github.com>
1 parent 99e4211 commit a4c5f2e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# CairoLS
2+
3+
CairoLS is an implementation of [Language Server Protocol][LSP] for the [Cairo] language.
4+
Cairo is the first Turing-complete language for creating provable programs for general computation.
5+
6+
## Quick start
7+
8+
CairoLS is distributed along with the [Scarb] package manager.
9+
To get started, install Scarb and the Cairo extension for your editor.
10+
11+
For Visual Studio Code, install
12+
the Visual Studio Code [Cairo 1.0](https://marketplace.visualstudio.com/items?itemName=starkware.cairo1) extension
13+
from the marketplace.
14+
15+
For other editors that support LSP,
16+
you can point the editor to the `scarb cairo-language-server` command to start the server.
17+
18+
## Support
19+
20+
For questions about CairoLS and official editor extensions, reach out to us on [Telegram].
21+
22+
[Cairo]: https://www.cairo-lang.org/
23+
24+
[LSP]: https://microsoft.github.io/language-server-protocol/
25+
26+
[Scarb]: https://docs.swmansion.com/scarb
27+
28+
[Telegram]: https://t.me/cairo_ls_support

0 commit comments

Comments
 (0)