Skip to content

docs(readme): fix repo links, badges and clone instructions #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
deaneeth merged 1 commit into from
Oct 24, 2026
Merged

docs(readme): fix repo links, badges and clone instructions #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# TinyGPU 🐉⚡

[![PyPI version](https://img.shields.io/badge/version-2.0.0-blue.svg)](https://pypi.org/project/tinygpu)
[![Version](https://img.shields.io/badge/version-2.0.0-blue.svg)](https://github.com/deaneeth/tiny-gpu/releases)
[![Python 3.13](https://img.shields.io/badge/Python-3.13-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![CI](https://github.com/deaneeth/tinygpu/actions/workflows/ci.yml/badge.svg)](https://github.com/deaneeth/tinygpu/actions)
[![CI](https://github.com/deaneeth/tiny-gpu/actions/workflows/ci.yml/badge.svg)](https://github.com/deaneeth/tiny-gpu/actions)
[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Tests](https://img.shields.io/github/actions/workflow/status/deaneeth/tinygpu/ci.yml?label=tests)](https://github.com/deaneeth/tinygpu/actions)
[![Tests](https://img.shields.io/github/actions/workflow/status/deaneeth/tiny-gpu/ci.yml?label=tests)](https://github.com/deaneeth/tinygpu/actions)

TinyGPU is a **tiny educational GPU simulator** - inspired by [Tiny8](https://github.com/sql-hkr/tiny8), designed to demonstrate how GPUs execute code in parallel. It models a small **SIMT (Single Instruction, Multiple Threads)** system with per-thread registers, global memory, synchronization barriers, branching, and a minimal GPU-like instruction set.

Expand Down Expand Up @@ -111,8 +111,8 @@ TinyGPU was built as a **learning-first GPU simulator** - simple enough for begi
### Clone and install

```bash
git clone https://github.com/deaneeth/tinygpu.git
cd tinygpu
git clone https://github.com/deaneeth/tiny-gpu.git
cd tiny-gpu
pip install -e .
pip install -r requirements-dev.txt
```
Expand Down
Loading