Skip to content

Commit cdbbdd7

Browse files
committed
docs: improve positioning to match with reality of the project
1 parent f27e94a commit cdbbdd7

1 file changed

Lines changed: 26 additions & 30 deletions

File tree

README.md

Lines changed: 26 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# ExplainThisRepo
22

3-
_The fastest way to understand any codebase in plain English using real project signals. Not blind AI guessing._
3+
_The fastest way to understand any unfamiliar codebase using real project signals. Not blind AI guessing. Signals first. LLM second_
44

5-
ExplainThisRepo analyzes real project signals; configs, entrypoints, manifests, dependencies graph, file structure and high-signal files producing a clear, structured `EXPLAIN.md` that explains what the codebase actually does and how it is organized in plain English.
5+
ExplainThisRepo analyzes real project signals; configs, entrypoints, manifests, dependencies graph, structures and high-signal files producing a clear, structured `EXPLAIN.md` that shows you what the codebase actually does, how it is organized, where to start, what to ignore, and what matters before touching unfamiliar codebases.
66

77
[![PyPI Version](https://img.shields.io/pypi/v/explainthisrepo?color=blue)](https://pypi.org/project/explainthisrepo/)
88
[![PyPI Downloads](https://static.pepy.tech/personalized-badge/explainthisrepo?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/explainthisrepo)
@@ -17,19 +17,16 @@ ExplainThisRepo analyzes real project signals; configs, entrypoints, manifests,
1717
## Key Features
1818

1919
- Understand any GitHub repository in seconds
20-
- Derives architectural summaries from repository structure and code signals.
21-
Not blind AI guessing
22-
- Deterministic repo signal extractor that feeds LLMs correctly. Signals first. LLM second
23-
- Translates complex code structures into plain English
20+
- System map that shows you where to start, what to ignore, what matters and why
21+
- Deterministic repo signal extractor that feeds LLMs correctly.
2422
- Speeds up understanding of unfamiliar codebases
2523
- Solves the "**garbage in, garbage out**" problem specifically for codebases
26-
- Extract architecture signals from configs, entrypoints, and manifests
27-
- System map that shows you where to start, what matters and what to ignore
28-
- Works with GitHub repositories, Local repositories, GitHub directories, local directories, GitHub files and local files
24+
- Multiple modes (quick, simple, detailed) that translates complex repository structure and code signals into architectural summaries. Not blind AI guessing. Signals first. LLM second
25+
- Works with GitHub repositories, local repositories, GitHub directories, local directories, GitHub files and local files
2926
- Supports private repositories and monorepos
3027
- Zero-cloning and remote analysis
28+
- Extract architecture signals from configs, entrypoints, and manifests
3129
- Outputs the explanation to an `EXPLAIN.md` file in your current directory, prints it directly in the terminal, or a specified output file (`.txt`, `.pdf`, `.docx`, `.md`)
32-
- Multiple explanation modes (quick, simple, detailed)
3330
- Additional tools: stack detection, repo map
3431

3532
## Installation
@@ -75,7 +72,7 @@ pip install explainthisrepo[groq]
7572

7673
Replace `owner/repo` with the GitHub repository identifier (e.g., `facebook/react`, `torvalds/linux`).
7774

78-
### Option 2: Install with npm (prebuilt binary, no Python required)
75+
### Option 2: Install with npm (prebuilt binary, no Python install required)
7976

8077
Install globally and use forever:
8178

@@ -87,11 +84,11 @@ explainthisrepo owner/repo
8784
<details>
8885
<pre>
8986
<code>
90-
# explainthisrepo .
91-
# explainthisrepo ./path/to/directory
92-
# explainthisrepo ./path/to/file.py
93-
# explainthisrepo owner/repo/path/to/file.py
94-
# explainthisrepo owner/repo/path/to/directory
87+
explainthisrepo .
88+
explainthisrepo ./path/to/directory
89+
explainthisrepo ./path/to/file.py
90+
explainthisrepo owner/repo/path/to/file.py
91+
explainthisrepo owner/repo/path/to/directory
9592
</code>
9693
</pre>
9794
</details>
@@ -105,22 +102,22 @@ npx explainthisrepo owner/repo
105102
<details>
106103
<pre>
107104
<code>
108-
# npx explainthisrepo .
109-
# npx explainthisrepo ./path/to/directory
110-
# npx explainthisrepo ./path/to/file.py
111-
# npx explainthisrepo owner/repo/path/to/file.py
112-
# npx explainthisrepo owner/repo/path/to/directory
105+
npx explainthisrepo .
106+
npx explainthisrepo ./path/to/directory
107+
npx explainthisrepo ./path/to/file.py
108+
npx explainthisrepo owner/repo/path/to/file.py
109+
npx explainthisrepo owner/repo/path/to/directory
113110
</code>
114111
</pre>
115112
</details>
116113

117114
## How it works
118115

119-
ExplainThisRepo uses a hybrid architecture:
116+
ExplainThisRepo uses a single source of truth architecture:
120117

121-
- Python core implementation (analysis, prompts, providers, output)
122-
- npm launches prebuilt native binaries (no Python install required)
123-
- pip installs the full Python package
118+
- Python is the core implementation (analysis, prompts, providers, output)
119+
- npm launches prebuilt native binaries (no Python install required)
120+
- pip installs the full Python package
124121

125122
> The npm and pip versions run the same core engine.
126123
@@ -130,9 +127,7 @@ Prebuilt standalone binaries are available for macOS, Linux, and Windows.
130127

131128
> Standalone binaries require no Python or Node installation and run as a single executable.
132129
133-
Download the latest release:
134-
135-
[github.com/calchiwo/ExplainThisRepo/releases/latest](https://github.com/calchiwo/ExplainThisRepo/releases/latest)
130+
Download the latest release: [ExplainThisRepo latest releases](https://github.com/calchiwo/ExplainThisRepo/releases/latest)
136131

137132
Or install directly:
138133
<details>
@@ -144,6 +139,7 @@ chmod +x explainthisrepo
144139
```
145140

146141
Linux
142+
147143
```bash
148144
curl -L https://github.com/calchiwo/ExplainThisRepo/releases/latest/download/explainthisrepo-linux-x64 -o explainthisrepo
149145
chmod +x explainthisrepo
@@ -174,7 +170,7 @@ explainthisrepo init
174170
# or npx explainthisrepo init
175171
```
176172

177-
> For details about how initialization works, see [docs/INIT.md](docs/INIT.md).
173+
> For details about how initialization works, see [docs/INIT.md](https://github.com/calchiwo/ExplainThisRepo/blob/main/docs/INIT.md).
178174
179175
## GitHub token Access (Private Repos & Rate Limits)
180176

@@ -561,7 +557,7 @@ I believe understanding code should feel less overwhelming and more approachable
561557

562558
## Special Thanks
563559

564-
- @Spectra010s for implementing the Node.js version of ExplainThisRepo and improving installation support for mobile environments like Termux
560+
- @Spectra010s for implementing the initial Node.js version of ExplainThisRepo and improving installation support for mobile environments like Termux
565561
- @HalxDocs for implementing the `--detailed` mode for deeper architectural explanations
566562

567563
## Contributions

0 commit comments

Comments
 (0)