# Tachyon

**Repository Path**: sureman_admin/Tachyon

## Basic Information

- **Project Name**: Tachyon
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-18
- **Last Updated**: 2024-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Tachyon is a metacircular VM for JavaScript (ECMAScript 5) written in
JavaScript. Please note that the project is still in the early stages, and,
as such, may be lacking in features or contain bugs.

INSTALLATION
------------

Requirements:
- A PC running Linux/Unix/MacOS
- An up to date version of gcc
- Build tools such as make

To install Tachyon:

1. Clone the Tachyon repository you have found this README file in. You've
probably already done this. If not, the command is:

    git clone <tachyon_repo_url>

2. Run the install script. This will fetch the V8 JavaScript VM, install
Tachyon-specific extensions onto it, and compile 32 and 64-bit binaries for
your system.

    ./install

3. Add the compiled V8 binaries to your path. On a typical Linux system, this
can be done by adding the following line to your ~/.bash_profile file:

    export PATH=$PATH:/home/<your_user_name>/Tachyon/source/deps/v8

4. Run make to build final dependencies for Tachyon

    make

5. You are done. You may test that Tachyon works properly by running its unit
tests using "make test", and "make test64" (for 64-bit compilation). This
should run all unit tests and display "All tests passed." when done.

    make test
    make test64     (64-bit machines only)

You may run the Tachyon read-eval print loop by running the tachyon script:

    ./tachyon


CONTACTING US
-------------

For assistance or other inquiries about Tachyon, you may contact
Maxime Chevalier-Boisvert, maintainer of the Tachyon VM at chevalma at iro
dot umontreal dot ca.