Skip to content

Commit

Permalink
docs: update test info
Browse files Browse the repository at this point in the history
  • Loading branch information
Sh0g0-1758 authored Feb 16, 2025
1 parent d98a37d commit 742e7ae
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Scarlet

[![ubuntu](https://github.com/Sh0g0-1758/scarlet/actions/workflows/UBUNTU_test_gcc.yml/badge.svg)](https://github.com/Sh0g0-1758/scarlet/actions/workflows/UBUNTU_test_gcc.yml) [![macos](https://github.com/Sh0g0-1758/scarlet/actions/workflows/MACOS_test_clang.yml/badge.svg)](https://github.com/Sh0g0-1758/scarlet/actions/workflows/MACOS_test_clang.yml) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/10029/badge)](https://www.bestpractices.dev/projects/10029)

Scarlet is a custom compiler developed in C++, designed with the primary goal of enhancing our understanding of compiler construction. The overarching objective is to implement an exceptionally fast machine learning framework built atop this compiler.

## Building Scarlet

To build Scarlet, invoke `cmake` with the `DCMAKE_CXX_COMPILER` flag within the build directory and then run make.
[![ubuntu](https://github.com/Sh0g0-1758/scarlet/actions/workflows/UBUNTU_test_gcc.yml/badge.svg)](https://github.com/Sh0g0-1758/scarlet/actions/workflows/UBUNTU_test_gcc.yml) [![macos](https://github.com/Sh0g0-1758/scarlet/actions/workflows/MACOS_test_clang.yml/badge.svg)](https://github.com/Sh0g0-1758/scarlet/actions/workflows/MACOS_test_clang.yml)

To build Scarlet, invoke `cmake` with the `DCMAKE_CXX_COMPILER` flag within the build directory and then run `make`.

```sh
cmake -DCMAKE_CXX_COMPILER=<compiler> ..
Expand All @@ -15,12 +15,26 @@ make

## Testing Scarlet

[![stress](https://github.com/Sh0g0-1758/scarlet/actions/workflows/UBUNTU_stress_test_gcc.yml/badge.svg)](https://github.com/Sh0g0-1758/scarlet/actions/workflows/UBUNTU_stress_test_gcc.yml) [![stress](https://github.com/Sh0g0-1758/scarlet/actions/workflows/UBUNTU_stress_test_clang.yml/badge.svg)](https://github.com/Sh0g0-1758/scarlet/actions/workflows/UBUNTU_stress_test_clang.yml)

To test Scarlet, execute the following command within the build directory:

```sh
make test-scarlet
```

To execute our custom stress tests, execute the following command within the `stress` directory:

```sh
./stress_test.sh
```

To check memory leaks in scarlet, run the following command within the build directory:

```sh
./check_memory_leaks.sh
```

## Supported Architectures

Scarlet currently supports the following architectures:
Expand Down

0 comments on commit 742e7ae

Please sign in to comment.