Skip to content

SETUP.md

Latest commit

 

History

History
96 lines (67 loc) · 1.65 KB

SETUP.md

File metadata and controls

96 lines (67 loc) · 1.65 KB

Quick Setup Guide

Running CiteBar on a New Computer

1. Prerequisites

First, make sure you have Xcode Command Line Tools installed:

xcode-select --install

2. Clone the Repository

git clone https://github.com/hichipli/CiteBar.git
cd CiteBar

3. Build and Run

# Build the project
make build

# Run the application
make run

Or create a local app bundle for manual install:

make install

To install directly to /Applications from the command line:

make install-sudo

4. First Time Setup

  1. Click the book icon in your menu bar
  2. Select "Settings..."
  3. Add your Google Scholar profile
  4. Set refresh interval (recommended 1 hour or more)

Troubleshooting

If Build Fails

# Clean and rebuild
make clean
make build

If App Doesn't Appear in Menu Bar

# Check if app is running
ps aux | grep CiteBar

# Restart the app
make run

Getting Your Google Scholar ID

  1. Go to your Google Scholar profile page
  2. Copy the ID from URL: scholar.google.com/citations?user=YOUR_ID_HERE
  3. Just copy the ID part (e.g., ABC123DEF)

Development Commands

make build      # Build release version
make debug      # Build debug version  
make run        # Build and run
make test       # Run tests
make clean      # Clean build artifacts
make xcode      # Open in Xcode
make check-docs # Verify documented commands stay in sync
make help       # Show all commands

System Requirements

  • macOS 13.0+
  • Swift 6.0+
  • Xcode 15.0+ (recommended for development)

Note: This app only accesses public Google Scholar data and all data is stored locally.