notedeck

One damus client to rule them all
git clone git://jb55.com/notedeck
Log | Files | Refs | README | LICENSE

README.md (1857B)


      1 # NoteDeck Columns
      2 
      3 A TweetDeck-style multi-column interface for Nostr built with Rust and egui.
      4 
      5 ## Overview
      6 
      7 NoteDeck Columns is a specialized UI component of the NoteDeck Nostr client that provides a TweetDeck-inspired multi-column layout for browsing Nostr content. It allows users to create customizable "decks" with multiple columns, each showing different types of Nostr content (home timeline, notifications, hashtags, profiles, etc.).
      8 
      9 ## Features
     10 
     11 - **Multi-column layout**: View different Nostr content types side by side
     12 - **Customizable decks**: Create and customize multiple decks for different use cases
     13 - **Column types**:
     14   - Universe (global feed)
     15   - Contact lists (follows)
     16   - Profiles
     17   - Notifications
     18   - Hashtags
     19   - Threads
     20   - Search results
     21   - Algorithmic feeds (e.g., last notes per pubkey)
     22 - **Interactions**: Post, reply, quote, and zap notes
     23 - **Media support**: View and upload images
     24 - **Multiple accounts**: Switch between multiple Nostr accounts
     25 
     26 ## Getting Started
     27 
     28 NoteDeck Columns is part of the larger NoteDeck ecosystem. To use it:
     29 
     30 1. Clone the NoteDeck repository
     31 2. Build the project with Cargo
     32 3. Run NoteDeck and select the Columns interface
     33 
     34 See the [DEVELOPER.md](DEVELOPER.md) file for detailed setup instructions.
     35 
     36 ## Architecture
     37 
     38 NoteDeck Columns is built using:
     39 
     40 - **Rust**: For performance and type safety
     41 - **egui**: For the UI rendering
     42 - **nostrdb**: For Nostr data storage and retrieval
     43 - **enostr**: For Nostr protocol communication
     44 
     45 The codebase is organized around the concept of timelines, views, and decks, with a column-based UI architecture.
     46 
     47 ## Contributing
     48 
     49 Contributions are welcome! Please see [DEVELOPER.md](DEVELOPER.md) for information on how to set up your development environment and contribute to the project.
     50 
     51 ## License
     52 
     53 NoteDeck Columns is licensed under the [GPL v3](LICENSE).