gitwtfhub

wtf is nous?

unitreign/nous — explained in plain English

Analysis updated 2026-05-18

7C++Audience · generalComplexity · 4/5LicenseSetup · hard

TL;DR

A personal fork of the microreader EPUB reader firmware for the Xteink X4 e-ink device, adding themes, hidden books, and reading stats.

Mindmap

mindmap
  root((Nous))
    What it does
      EPUB reader firmware
      Fork of microreader
    Features
      Four themes
      Hidden books
      Reading stats
    Build
      PlatformIO
      Desktop emulator
    Hardware
      Xteink X4
      ESP32-C3

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Why would anyone build with this?

REASON 1

Flash custom EPUB reader firmware onto an unlocked Xteink X4 e-ink device.

REASON 2

Switch between four visual themes to change how the book list looks and reads.

REASON 3

Hide specific EPUBs from the library and recents list using a hidden folder.

REASON 4

Test firmware changes in a desktop emulator without needing the physical device.

What's in the stack?

C++ESP32-C3PlatformIOSDL2

How it stacks up

unitreign/nous0x-shadow/crewtrackgingerbreadfork/wolf3d-path-traced
Stars777
LanguageC++C++C++
Setup difficultyhardmoderatehard
Complexity4/53/55/5
Audiencegeneralgeneraldeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you spin it up?

Difficulty · hard Time to first run · 1h+

Requires an unlocked Xteink X4 device and a firmware flashing tool, flashing on a locked device is not supported.

Licensed under GPL v2, a copyleft license that requires any distributed modified versions to also be released under GPL v2.

Wtf does this do

Nous is a personal fork of an open source EPUB reader firmware called microreader, built for the Xteink X4, a small e-ink device that uses an ESP32-C3 chip and an 800 by 480 screen. It adds and changes a number of features on top of the original project rather than being a wholly new reader. The interface offers four visual themes for the book list: one with a clean header and battery indicator, a bare minimal list with no decoration, a two line layout showing title and author with reading time, and a numbered catalog style with capitalized titles. Menu settings let a reader adjust the overall size of menus, sort the library alphabetically or by last opened, choose how much information shows per book in the list, and set list alignment in some themes. Library features include batch converting an entire collection of books at once with progress shown per book, indicators marking which books have already been converted, per book reading statistics such as open count and total time spent reading, and a hidden books feature where placing EPUBs in a specially named folder on the SD card keeps them out of the normal list and off the recents screen until accessed through a long press gesture. Other settings cover how the battery indicator is displayed, whether button hint icons show on screen, whether the display is in portrait or landscape orientation, an adjustable auto sleep timer, a custom sleep screen image, and the ability to remap which physical buttons control navigation and page turning. Custom bitmap fonts can also be loaded from the SD card for reading. Installing Nous requires an unlocked Xteink X4 device and flashing a firmware file either through a browser based tool or with a command line utility called esptool, and the README recommends backing up the existing firmware first. The project can also be built from source using PlatformIO, and it includes a desktop emulator that runs the full interface in a window without needing the physical device. Nous is released under the GPL version 2 license, inherited from the original microreader project it was forked from.

Yoink these prompts

Prompt 1
Walk me through flashing the Nous firmware onto my Xteink X4 using esptool.
Prompt 2
Help me build the Nous desktop emulator so I can test it without the physical device.
Prompt 3
Explain how to hide certain EPUBs from my library using the hidden books folder.
Prompt 4
Show me how to load a custom bitmap font onto the SD card for the reader.

Frequently asked questions

wtf is nous?

A personal fork of the microreader EPUB reader firmware for the Xteink X4 e-ink device, adding themes, hidden books, and reading stats.

What language is nous written in?

Mainly C++. The stack also includes C++, ESP32-C3, PlatformIO.

What license does nous use?

Licensed under GPL v2, a copyleft license that requires any distributed modified versions to also be released under GPL v2.

How hard is nous to set up?

Setup difficulty is rated hard, with roughly 1h+ to a first successful run.

Who is nous for?

Mainly general.

View the repo → Decode another repo

This repo across BitVibe Labs

Don't trust strangers blindly. Verify against the repo.