https://github.com/timroes/explain-plz-data
The data to the explain-plz tool, that explains the different projects in the android source code. Please make pull request if you can add anything to this data!
https://github.com/timroes/explain-plz-data
Last synced: 6 months ago
JSON representation
The data to the explain-plz tool, that explains the different projects in the android source code. Please make pull request if you can add anything to this data!
- Host: GitHub
- URL: https://github.com/timroes/explain-plz-data
- Owner: timroes
- Created: 2013-03-07T22:35:05.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2013-09-19T09:02:27.000Z (almost 13 years ago)
- Last Synced: 2025-11-12T22:03:57.084Z (8 months ago)
- Size: 169 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
explain-plz-data
================
This is the data for the [explain-plz](https://github.com/timroes/explain-plz) tool.
If you can add anything usefull to the data or want to modify explanations, please send pull
requests to this project.
The data should always aim to the most recent Android source code. So if projects have been
moved, this data won't work on older source code versions.
Files in this project
---------------------
The data in this project is organized in two type of files:
The index file (`index.idx`) contains a list of all folders, that has an explanation.
Each line in this file must have the following format:
`folder/to/explain|explanation_filename.txt`
The lines must be sorted alphabetically after the folder they explain (just look at the
`index.idx` file to understand).
The first name is the relative path inside the Android source code, that should be explained
and the second parameter is a (freely chosen) filename of the explanation file for this folder.
The explanation file must be a `txt` file, containing the explanation.
Each line in that explanation should have a maximum of 80 to 100 characters.