README for the Interpreter of SimpleML

(Remember to preview this .md file to see the correct formatting of this file)

Description

SimpleML is a simplistic programming language for newcomers to machine learning.

Installation

1. Install OCaml: You need to have OCaml installed on your system. You can download OCaml from the OCaml website: https://ocaml.org/install.

2. Install OPAM: If you don't already have OPAM installed, you can install it by following the instructions on the OPAM website: https://opam.ocaml.org/doc/Install.html.

3. Navigate to the project directory:

   cd file_path_to_the_repo_folder

4. Install dependencies:

   opam install . --deps-only

   Should any dependencies not get installed with this command, use the following instead:

   opam install name_of_dep

   Note: If you haven't initialized OPAM on your system, you'll need to do so first with:

   opam init

   You may also need to run:

   eval $(opam env)

   This is to ensure that your environment is correctly configured for OPAM.

Usage

• Note: Remember to still be located in the root project directory as you were during installation.

  You can check whether you are in the root project directory by running the following command

  ls 

  After running this command, you should see the following output in the terminal:

  Makefile   bin           examples             lib            test
  README.md  combined.sm   grammar.txt          run_test.sh    unit_tests
  _build     dune-project  integration_test.sh  simpelml.opam

• Run the interpreter on the file test.sm:

  make

• Run the unit testing for the lexer:

  make lexerTest

• Run the unit testing for the parser:

  make parserTest

• Run the unit testing for the interpreter:

  make interpTest

• Run the integration tests: First, make sure the scripts are executable:

  chmod +x integration_test.sh
  chmod +x run_test.sh

  Then, run the integration tests:

  ./run_test.sh

Contact

Should there be any problems with installation or usage, do not hesitate to contact us at: cs-24-sw-kbh-4-gr4@student.aau.dk