Skip to content

Latest commit

 

History

History
191 lines (148 loc) · 6.45 KB

README.en.md

File metadata and controls

191 lines (148 loc) · 6.45 KB

cover

macOS 14.0+ iPadOS 17.0+ visionOS 1.0+ Swift 5.9+ gRPC

wakatime + wakatime

100% NATIVE, multi-platform, collaborative reference manager based on SwiftUI.

简体中文 | English

Core Features

  • Reference Management
    • Add paper via DOI/URL
    • Export citations in BibTeX, GB/T 7714, and other formats
  • Cross-platform, cross-device access
    • View paper on Mac, iPad and Apple Vision Pro
    • Use Apple Pencil on iPad to markup PDF
    • Data synchronization across devices
  • Collaborative reading
    • Real-time synchronization of rich-text notes
    • Real-time synchronization of paper annotations
  • AI-assisted reading
    • Translation
    • Paper explaining, summarization, and rewriting
    • Cite paper content while chatting with GPT and retaining context

For more details, please refer to the Feature List.

Supported Platforms

  • macOS 14.0+
  • iPadOS 17.0+
  • visionOS 1.0+

Development Requirements

Preparation

  1. Clone the entire repo, including paperpilot-common submodule

    git clone --recursive https://github.com/LSX-s-Software/PaperPilotApp.git

  2. Rename the team.xcconfig.template file in the project root directory to team.xcconfig and fill in your DEVELOPMENT_TEAM and PRODUCT_BUNDLE_IDENTIFIER.

  3. Install protoc、protoc-gen-swift、protoc-gen-grpc-swift, and make sure it can be used in Shell

  4. Run Xcode (Or Xcode beta) using Shell command

    Since running Xcode directly can cause it to not inherit environment variables registered in the shell, the SwiftProtobuf plugin won't be able to find the protoc command during compilation. Therefore, it is necessary to run Xcode in the shell using the following command:

    open /Applications/Xcode.app

  5. Open the project settings in Xcode and modify the DEVELOPMENT_TEAM and PRODUCT_BUNDLE_IDENTIFIER in the project targets other than PaperPilot.

  6. Done.

Related Repositories

Feature List

Projects

  • Local Projects
    • No registration required
    • Offline use
    • Convert local projects into remote projects
  • Remote Projects
    • Partial offline functionality
    • Automatically sync project changes, automatically resolve conflicts
    • Invite others to join projects via invitation code or link
    • Join projects created by others by entering an invitation code
    • View invitation information on the website and open Paper Pilot by URL Scheme
    • Share links with Open Graph Protocol support
    • View project member list
    • Quit joined projects

Papers

  • Retrieve paper information and PDF files via URL/DOI
  • Add papers from local files
  • Import PDF files through drag and drop, system share sheet, etc.
  • Paper List
    • Display paper title, authors, publication year, publication, event, add date, tags, read status, etc.
    • Customizable list (hide, rearrange columns, adjust column width)
    • Customizable sorting
    • Batch set read/unread status, delete papers
    • Copy paper information
    • Delete PDF files of papers to free up space
  • Batch export citations in BibTeX, GB/T 7714, JSON, and CSV formats

Paper Reader

  • PDF Navigator
    • Switch navigator modes
      • PDF Outline
      • PDF Thumbnails
      • Bookmarks
      • Hide
    • Highlight the navigator based on the current page
    • Jump to a specific page through the navigator
  • PDF Reader
    • Vector rendering
    • Text selection
    • Switch reading modes
      • Single page
      • Continuous single page
      • Double page
      • Continuous double page
    • Zoom
    • Link navigation
  • Annotations
    • Real-time synchronization
    • Multiple annotation types
      • Highlight
      • Underline
      • [iPad only] Draw annotations with finger or Apple Pencil
    • Switch annotation colors
  • Notes
    • Real-time synchronization
    • Automatically resolve conflicts
    • Rich-text (using Markdown format)
    • Adjust font size
  • Search
    • Search within PDF
    • Customizable search options (case sensitivity)
    • Display search result list
    • Highlight search results in PDF
  • Bookmarks
  • Paper text translation
    • Automatic language detection
    • Automatically remove PDF line breaks
  • Reading Timer

AI Features

  • AI-assisted reading
    • Paper explaining, translation, summarization, rewriting
    • Quote paper content in chat
    • Free-form chat
    • Retain the most recent 10 conversations as context

Users

  • Register and log in
  • Customizable avatar

Settings

  • Display server status
  • View local file space usage
  • Clean local files
  • Clear all data

System Adaptations

  • Follow Apple's Human Interface Guidelines and the system's interface styles

  • List right-click/long-press menu (aka. context menu)

  • Size-adjustable and hidable sidebar

  • Perform common operations via macOS's menu bar and shortcuts

  • Add papers and PDF files via drag-and-drop

  • Support opening the paper reader in the same or new window on iPadOS

  • Use PencilKit on iPadOS to support drawing annotations with Apple Pencil

  • Use Ornament on visionOS to display detailed paper information

  • Support searching projects and papers via Spotlight

  • Support importing PDF files via the system's share sheet

  • Launch via URL Scheme

  • Dark mode

  • Use SwiftData for data persistence

  • Internationalization (i18n)

    • English

    • Simplified Chinese

Others

  • Asynchronous execution for time-consuming operations, with progress bar/activity indicator shown
  • Play transition animations when controls appear/disappear