Value and Documentation

Author: Kaweees

README.md

@@ -49,8 +49,6 @@ A three-dimensional header-only graphics library written in C++13 and accelerate
 
 Before attempting to build this project, make sure you have [Nix](https://nixos.org/download.html) with [Flake](https://nixos.wiki/wiki/Flakes) support installed on your machine.
 
-Additionally, if you wish to utilize the GPU acceleration features, you will need to have [CUDA Toolkit](https://developer.nvidia.com/cuda-downloads) or [Apple Metal](https://developer.apple.com/metal/cpp/) installed on your machine.
-
 ### Installation
 
 To get a local copy of the project up and running on your machine, follow these simple steps:
@@ -81,12 +79,20 @@ To get a local copy of the project up and running on your machine, follow these
    just run <package_name>
    ```
 
+### Add as a dependency
+
+Add the following line to your `build.zig` file:
+
+```sh
+zig fetch --save https://github.com/Kaweees/micrograd
+```
+
 ## Usage
 
-kiwiGL is designed to be easy to use. You can include the library in your C++ project by adding the following line to your source files:
+micrograd is designed to be easy to use. You can include the library in your Zig project by adding the following line to your source files:
 
-```cpp
-#include <kiwigl/kiwigl.h>
+```zig
+const micrograd = @import("micrograd");
 ```
 
 ### Benchmarks
@@ -100,21 +106,6 @@ kiwiGL is capable of rendering 3D scenes with thousands of triangles at interact
 | `bunny` | Render a Stanford Bunny with 69451 triangles | 60 FPS |
 | `dragon` | Render a Stanford Dragon with 871306 triangles | 60 FPS |
 
-### Conventions
-
-kiwiGL uses the following conventions:
-
-- [left-handed coordinate system](https://www.scratchapixel.com/lessons/mathematics-physics-for-computer-graphics/geometry/coordinate-systems.html#:~:text=The%20differentiation%20between%20left%2Dhanded,a%20right%2Dhand%20coordinate%20system)
-- [counter-clockwise winding order](https://learnwebgl.brown37.net/model_data/model_volume.html#:~:text=Winding%20Order%20for%20a%20triangle,the%20front%20of%20the%20triangle.) for triangle vertices
-
-### Keyboard Controls
-
-kiwiGL uses the following keyboard shortcuts:
-
-| Command Keybind | Command Description |
-| --------------- | ------------------- |
-| <kbd>CTRL</kbd> + <kbd>q</kbd> | Quit the application |
-
 <!-- PROJECT FILE STRUCTURE -->
 ## Project Structure
 

build.zig

@@ -113,4 +113,21 @@ pub fn build(b: *std.Build) void {
     const test_step = b.step("test", "Run unit tests");
     test_step.dependOn(&run_lib_unit_tests.step);
     test_step.dependOn(&run_exe_unit_tests.step);
+
+    // Creates a step for generating documentation
+    const lib_docs = b.addObject(.{
+        .name = "micrograd-docs",
+        .root_module = lib_mod,
+    });
+
+    // Generate documentation and install it to zig-out/docs
+    const docs = lib_docs.getEmittedDocs();
+    const install_docs = b.addInstallDirectory(.{
+        .source_dir = docs,
+        .install_dir = .prefix,
+        .install_subdir = "docs",
+    });
+
+    const docs_step = b.step("docs", "Generate and install documentation");
+    docs_step.dependOn(&install_docs.step);
 }

src/engine.zig

@@ -0,0 +1,20 @@
+//! This file provides
+
+const std = @import("std");
+const arch = @import("../arch/arch.zig");
+
+/// Represents a Scalar value
+pub fn Value(comptime T: type) type {
+    return struct {
+        /// Value of the register
+        value: T,
+
+        /// Initialize the Value
+        pub fn init(value: T) @This() {
+            return @This(){
+                .value = value,
+            };
+        }
+        
+    };
+}