Skip to content

README.md

Latest commit

 

History

History
107 lines (76 loc) · 2.08 KB

README.md

File metadata and controls

107 lines (76 loc) · 2.08 KB

Marmoset - Hacker News Client

Marmoset Logo

A modern, native Hacker News client for Linux desktops built with Python and GTK4. Marmoset provides a clean and intuitive interface to browse Hacker News stories, comments, and more.

✨ Features

  • Browse top, new, and best stories from Hacker News
  • View story details including comments and scores
  • View linked pages
  • Save and share stories
  • Access stories offline
  • Star your favorite stories for quick access
  • Clean, native GTK4 interface that follows GNOME HIG
  • Fast and lightweight

🚀 Installation

Requirements

  • Python 3.12 or later
  • GTK4 and libadwaita
  • Python development headers and build dependencies

From Source

  1. Clone the repository:

    git clone https://github.com/yourusername/marmoset.git
cd marmoset

  2. Create and activate a virtual environment (recommended):

    python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

  3. Install dependencies:

    pip install -e .

  4. Run the application:

    python -m marmoset

Using Flatpak (Coming Soon)

flatpak install flathub com.tenderowl.marmoset
flatpak run com.tenderowl.marmoset

🛠️ Development

Dependencies

  • Python 3.13+
  • GTK4
  • libadwaita
  • meson
  • ninja
  • gettext
  • appstream-util

Building

meson setup builddir --prefix=/usr
cd builddir
ninja
ninja install

Running from source

./marmoset

📝 License

Marmoset is licensed under the MIT License. See the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📧 Contact

🙏 Acknowledgments

  • Hacker News for their public API
  • The GNOME project for GTK4 and libadwaita
  • All contributors and testers

Made with ☕ and 🐈 by Andrey Maksimov