Project setup and compilation

Setting up and compiling the Virtual Processor project is straightforward. This guide will walk you through the process of getting the project up and running on your local machine. The project is developed in C and uses CMake for build automation.

Prerequisites

Ensure you have the following tools installed before you begin:

• GCC (GNU Compiler Collection)
• Visual Studio Code (Recommended IDE)
• CMake (Build system)

How to install CMake: https://earthly.dev/blog/installandrun-cmake-on-windows/

Cloning the repository

Start by cloning the project repository to your local machine. Use the following command in your terminal:

git clone [repository URL]

Opening the project

After cloning, open the project folder in Visual Studio Code or your preferred IDE.

Using CMakeLists

CMakeLists.txt is the configuration file used by CMake. It defines how your project is built.

Structure of CMakeLists.txt

• Specify the project's name and version:

  project(VirtualProcessor VERSION 1.0)
  

• Define the executable targets from the source files:

  add_executable(VirtualProcessor main.c)
  

• Include directories where header files are located (if necessary).

• Link any external libraries (if needed).

Running CMake

To generate the build files and compile the project, follow these steps:

1. Navigate to the project directory:

   cd path/to/VirtualProcessor
   

2. Generate build files:

   cmake .
   

3. Compile the project:

   make
   

Compilation process

The make command compiles the source files according to the instructions in CMakeLists.txt, creating the executable for the Virtual Processor. This process involves compiling each source file and linking them together to form the final executable.

Troubleshooting

In case of errors during the setup or compilation process, consider the following troubleshooting steps:

• Verify paths: Ensure all paths specified in CMakeLists.txt are correct, especially those pointing to source files and libraries.
• Check dependencies: Confirm that all required dependencies are installed and properly linked in the CMakeLists.txt file.
• CMake errors: If CMake generates errors, check the syntax and settings in CMakeLists.txt. Refer to the CMake documentation for guidance.
• Compiler errors: For compiler-related issues, check for syntax errors, missing includes, or other common C programming mistakes in your source files.
• Seek community help: If the issue persists, seek advice from community forums or discussion boards related to C programming, CMake, or the specific tools you are using.

Final steps

Once the project is successfully compiled:

• Test the executable: Run the compiled executable to ensure it's functioning as expected.
• Debugging: Utilize debugging tools available in your IDE or other debugging software to troubleshoot any runtime issues.
• Iterative development: As you develop further, repeat the compilation process after making changes to the source code.