linuxmint / linuxmint/nemo-extensions

[nemo-preview] [feature request] Preview README with directory

Open
#546 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
486
Forks
172
PR merge metrics
No merged PRs in 30d

Description

Hello,

It would be handy if nemo-preview on a directory also displayed (the beginning) of a potential README file in the directory in question.

I'm willing to help with the implementation, but due to lack of time, I would need someone to tell me where to start and where to look for documentation.

(It would also be nice to have a directory's README displayed somewhere when navigating in that directory, but that would require a UI redesign. Are there any plans to add a preview panel?)

Thanks!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the nemo-preview extension entry point and the code that handles directory previews; the issue does not name specific files or tests. Read the extension documentation and existing preview behavior before deciding how README files are selected and truncated. Done means opening a directory preview also shows the beginning of a README from that directory; the proposed UI redesign is out of scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
desktop
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.