Skip to content

Commit e3be663

Browse files
committed
docs: readme
1 parent 83c6d5d commit e3be663

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
![branding](docs/imgs/branding.png)
22

3+
Explore the demo paper’s supporting assets in the [/demo](/demo/) folder.
4+
35
<div align="center">
46
<a href="https://chromewebstore.google.com/detail/paperdebugger/dfkedikhakpapbfcnbpmfhpklndgiaog" target="_blank"><img src="https://img.shields.io/chrome-web-store/users/dfkedikhakpapbfcnbpmfhpklndgiaog?label=Users" alt="Chrome Web Store Users"/></a>
57
<a href="https://chromewebstore.google.com/detail/paperdebugger/dfkedikhakpapbfcnbpmfhpklndgiaog" target="_blank"><img src="https://img.shields.io/chrome-web-store/v/dfkedikhakpapbfcnbpmfhpklndgiaog?label=Chrome%20Web%20Store&logo=google-chrome&logoColor=white" alt="Chrome Web Store Version"/></a>
@@ -22,15 +24,25 @@
2224

2325
## 📋 Table of Contents
2426

27+
- [📋 Table of Contents](#-table-of-contents)
2528
- [✨ Features](#-features)
2629
- [🎯 Quick Start](#-quick-start)
2730
- [For Users](#for-users)
2831
- [Custom Endpoint Configuration](#custom-endpoint-configuration)
32+
- [🏗️ Architecture Overview](#️-architecture-overview)
2933
- [🛠️ Development Setup](#️-development-setup)
3034
- [Prerequisites](#prerequisites)
35+
- [System Requirements](#system-requirements)
36+
- [Development Tools](#development-tools)
37+
- [Quick Installation (macOS/Linux with Homebrew)](#quick-installation-macoslinux-with-homebrew)
3138
- [Backend Build](#backend-build)
39+
- [1. Clone the Repository](#1-clone-the-repository)
40+
- [2. Start MongoDB](#2-start-mongodb)
41+
- [3. Environment Configuration](#3-environment-configuration)
42+
- [4. Build and Run](#4-build-and-run)
3243
- [Frontend Extension Build](#frontend-extension-build)
33-
- [🏗️ Architecture Overview](#️-architecture-overview)
44+
- [Chrome Extension Development](#chrome-extension-development)
45+
- [Installing the Development Extension](#installing-the-development-extension)
3446

3547
## ✨ Features
3648

0 commit comments

Comments
 (0)