Bug 39642 - [EasyHack] Improve README files in top-level module directories
Summary: [EasyHack] Improve README files in top-level module directories
Status: RESOLVED FIXED
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: LibreOffice (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: Other All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard:
Keywords: difficultyBeginner, easyHack, topicCleanup
Depends on:
Blocks:
 
Reported: 2011-07-28 10:13 UTC by Björn Michaelsen
Modified: 2015-12-16 05:13 UTC (History)
2 users (show)

See Also:
Crash report or crash signature:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Björn Michaelsen 2011-07-28 10:13:09 UTC 
=== Add README files to top-level module directories ===

'''Background:''' We have a lot of modules in LibreOffice, two hundred or so. It would be nice if each of these had a brief 'README' file in the top-level describing the approximate function of the module, and what code is inside it. Some of these should be really brief (for external modules eg. 'libxml2/') - others could be more detailed for eg. 'sw/' The README files should probably match [Development/Code_Overview] - and be kept in sync. somehow. Potentially that could be scripted by someone clueful.

'''Skills: '''reading, the wiki, grokking the modules, writing english, shell ?, git diff
Comment 1 Josh Heidenreich 2012-02-21 17:56:17 UTC 
Most modules now have README files, and they can be viewed at:
http://docs.libreoffice.org

Improvements can still be made though, especially to to larger, more complex modules
Comment 2 Michael Meeks 2012-04-04 08:33:15 UTC 
Yep - thanks for your great work here Josh, would you like to close the bug ? hopefully the README's are past the tipping point here, where they simply improve with time.

Did we manage to get your scripts sorted out, committed somewhere, and run regularly on an official server ? :-)
Comment 3 Robinson Tryon (qubit) 2015-12-16 05:13:26 UTC 
Migrating Whiteboard tags to Keywords: (EasyHack,DifficultyBeginner,TopicCleanup)
[NinjaEdit]