|
| 1 | +# GitHub Repository Information |
| 2 | + |
| 3 | +## Description |
| 4 | +Advanced PDF layout analysis engine for extracting figures, tables, and structured content from complex engineering documents using computer vision and machine learning. |
| 5 | + |
| 6 | +## Topics (Tags) |
| 7 | +- pdf |
| 8 | +- layout-analysis |
| 9 | +- computer-vision |
| 10 | +- document-processing |
| 11 | +- figure-extraction |
| 12 | +- table-detection |
| 13 | +- engineering-documents |
| 14 | +- technical-documents |
| 15 | +- opencv |
| 16 | +- pymupdf |
| 17 | +- python |
| 18 | +- machine-learning |
| 19 | +- ocr |
| 20 | +- document-parsing |
| 21 | +- multi-column |
| 22 | +- text-extraction |
| 23 | +- image-processing |
| 24 | + |
| 25 | +## How to Add Contributors |
| 26 | + |
| 27 | +### Method 1: Through GitHub Web Interface |
| 28 | +1. Go to your repository: https://github.com/Magnet-AI/Quanta |
| 29 | +2. Click on "Settings" (in the repository menu) |
| 30 | +3. Scroll down to "Manage access" in the left sidebar |
| 31 | +4. Click "Invite a collaborator" |
| 32 | +5. Enter their GitHub username or email |
| 33 | +6. Choose permission level: |
| 34 | + - **Read**: Can view and clone |
| 35 | + - **Triage**: Can manage issues and pull requests |
| 36 | + - **Write**: Can push to repository |
| 37 | + - **Maintain**: Can manage repository settings |
| 38 | + - **Admin**: Full access |
| 39 | + |
| 40 | +### Method 2: Through GitHub CLI |
| 41 | +```bash |
| 42 | +# Install GitHub CLI if you don't have it |
| 43 | +brew install gh |
| 44 | + |
| 45 | +# Authenticate |
| 46 | +gh auth login |
| 47 | + |
| 48 | +# Add a collaborator |
| 49 | +gh api repos/Magnet-AI/Quanta/collaborators/USERNAME -X PUT -f permission=write |
| 50 | +``` |
| 51 | + |
| 52 | +### Method 3: Through Git Commands (for co-authors) |
| 53 | +```bash |
| 54 | +# When committing, add co-author information |
| 55 | +git commit -m "Add new feature |
| 56 | +
|
| 57 | +Co-authored-by: Contributor Name <[email protected]>" |
| 58 | +``` |
| 59 | + |
| 60 | +## Repository Settings to Update |
| 61 | + |
| 62 | +### 1. Description |
| 63 | +Set this in the repository settings: |
| 64 | +"Advanced PDF layout analysis engine for extracting figures, tables, and structured content from complex engineering documents using computer vision and machine learning." |
| 65 | + |
| 66 | +### 2. Topics |
| 67 | +Add these topics in the repository settings: |
| 68 | +- pdf |
| 69 | +- layout-analysis |
| 70 | +- computer-vision |
| 71 | +- document-processing |
| 72 | +- figure-extraction |
| 73 | +- table-detection |
| 74 | +- engineering-documents |
| 75 | +- technical-documents |
| 76 | +- opencv |
| 77 | +- pymupdf |
| 78 | +- python |
| 79 | +- machine-learning |
| 80 | +- ocr |
| 81 | +- document-parsing |
| 82 | +- multi-column |
| 83 | +- text-extraction |
| 84 | +- image-processing |
| 85 | + |
| 86 | +### 3. Website (if you have one) |
| 87 | +Leave blank for now, or add your personal website |
| 88 | + |
| 89 | +### 4. Social Preview |
| 90 | +Upload the quanta.png logo as the social preview image |
0 commit comments