Skip to content

Commit dbe0dbf

Browse files
committed
Added ToC to ReadMe
1 parent a890ebe commit dbe0dbf

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@
44

55
The code analysis is non-judgemental. It simply collects the facts such as what languages and frameworks are used, number of lines of code or library use. All that data is assembled into a Developer Profile to help someone looking for your skills to find you.
66

7+
## Table of Contents
8+
9+
- [Privacy](#privacy)
10+
- [Quick start](#quick-start)
11+
- [Adding more commit emails](#adding-more-commit-emails)
12+
- [Adding more projects to your profile](#adding-more-projects-to-your-profile)
13+
- [Detailed usage instructions](#detailed-usage-instructions)
14+
- [Additional options](#additional-options)
15+
- [Processing settings](#processing-settings)
16+
- [Profile settings](#profile-settings)
17+
- [Debug settings](#debug-settings)
18+
- [Additional commands](#additional-commands)
19+
- [Using StackMuncher app on multiple machines](#using-stackmuncher-app-on-multiple-machines)
20+
- [Limitations](#limitations)
21+
- [Troubleshooting](#troubleshooting)
22+
- [Bug reports and contributions](#bug-reports-and-contributions)
23+
724
## Privacy
825

926
1. All code analysis is done locally. Not a single line of code is leaving your machine.
@@ -12,7 +29,7 @@ The code analysis is non-judgemental. It simply collects the facts such as what
1229

1330
The app creates a sample stack report on the first run over a project without submitting it (dryrun). You can review the report before continuing.
1431

15-
## Examples
32+
**Examples**
1633

1734
* anonymous profile: https://stackmuncher.com/?dev=9PdHabyyhf4KhHAE1SqdpnbAZEXTHhpkermwfPQcLeFK
1835
* public profile: https://stackmuncher.com/rimutaka
@@ -34,7 +51,7 @@ The app will access `.git` folder inside `path_to_any_of_your_local_projects` di
3451

3552
The **default config** of the app assumes that it is run on a development machine from the root folder of a repository you made commits to.
3653

37-
#### Example
54+
**Example**
3855

3956
I made commits to `~/rust/quickxml_to_serde` project recently and want to test StackMuncher app on it:
4057
```shell
@@ -50,7 +67,7 @@ I made commits to `~/rust/quickxml_to_serde` project recently and want to test S
5067

5168
We often commit to the same repo using different `user.email` Git setting. Run `git shortlog -s -e --all` to check if you made commits under any other email addresses.
5269

53-
#### Example
70+
**Example**
5471

5572
Find out what email addresses were used in commits to `xml_to_serde` repo:
5673

@@ -188,12 +205,12 @@ _The current version of the app is at alpha-stage and should be used for testing
188205

189206
We want to hear about as many issues users run into as possible. Copy-paste the log and error messages printed by the app into https://github.com/stackmuncher/stm_app/issues/new/choose and let us help you.
190207

191-
#### Pre-requisites:
208+
**Pre-requisites:**
192209

193210
* Git is installed and its `user.email` setting was configured
194211
* the project to be analyzed has commits from the same author/committer as in `user.email` setting
195212

196-
#### If the app did something, but no report was submitted:
213+
**If the app did something, but no report was submitted:**
197214

198215
* look through the log it printed for clues
199216
* run `stackmuncher view_config` and check the output in `reports` folder - there should be at least 4 files:

0 commit comments

Comments
 (0)