Skip to content

Commit

Permalink
Merge branch 'main' into documentation-intro-NethermindEth#328
Browse files Browse the repository at this point in the history
  • Loading branch information
TAdev0 authored Jun 3, 2024
2 parents 4637ac0 + bd2d4dc commit 013769f
Show file tree
Hide file tree
Showing 42 changed files with 4,325 additions and 498 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Nethermind

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This Virtual Machine is still in development and there is no public release avai
Currently, it is only possible to use it by building it from source by following these instructions:

1. Clone the repo to your machine: `git clone https://github.com/NethermindEth/cairo-vm-go`.
2. Install `Go` on your PC, instructions [here](https://go.dev/.doc/install).
2. Install `Go` on your PC, instructions [here](https://go.dev/dl/).
3. Execute on the root folder of the repo: `make build`.
4. Make sure everything is running smoothly by executing: `make unit`.

Expand Down Expand Up @@ -79,6 +79,17 @@ Integration tests are run with:
make integration
```

Integration tests are run with filters in the following two methods, with the first method having higher priority.

```bash
#1) set global environment variable `INTEGRATION_TESTS_FILTERS`
export INTEGRATION_TESTS_FILTERS=fib,alloc
make integration

#2) set by editing `INTEGRATION_TESTS_FILTERS=` in the `./integration_tests/.env` file
make integration
```

If you want to execute all tests of the project:

```bash
Expand Down
Loading

0 comments on commit 013769f

Please sign in to comment.