Skip to content
This repository has been archived by the owner on Jul 7, 2024. It is now read-only.

Commit

Permalink
add additional headers to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
BluBloos committed Aug 29, 2023
1 parent 9bf36ff commit 91a3661
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ https://github.com/BluBloos/Portable-Programming-Language
NOTE: The compiler only runs on Windows host machines, and it will only compile
win32 binaries.

## Dependencies

This project uses the MSVC linker, so you will need to install <a
href="https://visualstudio.microsoft.com/vs/">Visual Studio</a> if you haven't
already. At the time of writing, the latest version is 2019, so I cannot
Expand All @@ -35,6 +37,8 @@ Finally, some Python dependencies must be installed,
pip install -r requirements.txt
```

## Setup

To use the compiler, open a new command prompt and run,

```
Expand All @@ -43,6 +47,8 @@ shell.bat

This will setup the MSVC environment, so that link.exe is accessible.

## Normal Usage

To run the compiler for a novel program, run the following,

```
Expand All @@ -52,6 +58,8 @@ python compiler.py <fileName>
Plasma Compiler will compile the file, run it, and display the result of the
program to the console window.

## Running Tests

To run the pre-made tests:

```
Expand Down

0 comments on commit 91a3661

Please sign in to comment.