https://github.com/starkware-libs/cairo-lang

https://github.com/starkware-libs/cairo-lang

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/starkware-libs/cairo-lang
• Owner: starkware-libs
• License: apache-2.0
• Created: 2020-10-31T20:51:23.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-26T12:16:13.000Z (18 days ago)
• Last Synced: 2024-12-04T12:06:52.580Z (10 days ago)
• Language: Python
• Size: 6.07 MB
• Stars: 1,350
• Watchers: 36
• Forks: 266
• Open Issues: 133
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• Library-of-Ethereum - Cairo - Officila Cairo Repo (Smart Contracts / Cairo)

README

        
# Introduction

[Cairo](https://cairo-lang.org/) is a programming language for writing provable programs.

# Documentation

The Cairo documentation consists of two parts: "Hello Cairo" and "How Cairo Works?".

Both parts can be found in https://cairo-lang.org/docs/.

We recommend starting from [Setting up the environment](https://cairo-lang.org/docs/quickstart.html).

# Installation instructions

You should be able to download the python package zip file directly from

[github](https://github.com/starkware-libs/cairo-lang/releases/tag/v0.13.3)

and install it using ``pip``.

See [Setting up the environment](https://cairo-lang.org/docs/quickstart.html).

However, if you want to build it yourself, you can build it from the git repository.

It is recommended to run the build inside a docker (as explained below),

since it guarantees that all the dependencies

are installed. Alternatively, you can try following the commands in the

[docker file](https://github.com/starkware-libs/cairo-lang/blob/master/Dockerfile).

## Building using the dockerfile

*Note*: This section is relevant only if you wish to build the Cairo python-package yourself,

rather than downloading it.

The root directory holds a dedicated Dockerfile, which automatically builds the package and runs

the unit tests on a simulated Ubuntu 18.04 environment.

You should have docker installed (see https://docs.docker.com/get-docker/).

Clone the repository and initialize the git submodules using:

```bash

> git clone [email protected]:starkware-libs/cairo-lang.git

> cd cairo-lang

```

Build the docker image:

```bash

> docker build --tag cairo .

```

If everything works, you should see

```bash

Successfully tagged cairo:latest

```

Once the docker image is built, you can fetch the python package zip file using:

```bash

> container_id=$(docker create cairo)

> docker cp ${container_id}:/app/cairo-lang-0.13.3.zip .

> docker rm -v ${container_id}

```