From ce79aa22e46048e0ab4189a154fde764ff5e4342 Mon Sep 17 00:00:00 2001 From: rsiddharth Date: Sun, 3 Nov 2013 12:20:23 +0530 Subject: updated README. Put info about codebase in MANIFEST. --- MANIFEST | 65 +++++++++++++++++++++++++++++ README | 142 +++++---------------------------------------------------------- 2 files changed, 76 insertions(+), 131 deletions(-) create mode 100644 MANIFEST diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..bfe23fb --- /dev/null +++ b/MANIFEST @@ -0,0 +1,65 @@ +Overview of the scruf source +============================ + +This section is for folks who wish to read/explore/hack/study/etc the +source code. + +* Run.java : This is entry point for scruf. It contains the `main' + function starts the nuts & bolts of scruf. + +* parser/ : This directory contains all the `Parsers' and + related classes. + + The 'Parser' interface is defined in Parser.java and all parsers + implement this interface. + + The functionality of a Parser is to convert a specific scruffy + markup into corresponding HTML5 element. For instance, the `Link' + parser converts scruffy marked up links into corresponding HTML5 + links; The `CodeBlocks' parsers looks for code blocks in the marked up + file and converts the block into a HTML5 code block. + + `ParserList' class contains a list of all parsers that is used to + convert a scruffy markup file to valid HTML5. + +* conversion/ : Contains classes responsible for traversing + directories looking for scruffy marked up files & feeding the marked + up files to a list of parsers to convert into HTML5 + + `ConvertDirectory' class recursively traverses a directories & when + it finds a scruffy marked up file, it gives it to the `ConvertFile' + class to perform HTML5 conversion. + + `ConvertFile' gets a scruffy marked up file and feeds the file to a + list of parsers to convert to HTML5 and writes the converted HTML5 + file to the disk. + + + ignore/ : This directory contains a class which help identify + sub-directories that are to be ignored. + +* index/ : Contains the `IndexCreator' class which adds links to newly + converted HTML5 files to the directory's `index.scruffy' file + + `index.scruffy' is created in directories that have scruffy marked + up files and it contains a list of links to all the HTML5 files + converted by scruf. + +* io/ : Contains classes for reading/writing files. + +* status/ : Contains the `PresentFile' class which has the details + about the marked up file that is being converted to HTML5. + + The `DirectoryInfo' class has the `level' of the directory being + traversed with respect to the `root' directory. + + The `root' directory is the top level directory given by the user to + perform HTML5 conversion. + +* styling/ : This directory contains the StyleChecker class which + makes sure that every directory, that has a scruffy marked up file, + contains a dedicated style sheet -- style.css. + + The style.css is the default style sheet used by scruf. + +* docs/ directory: Contains documentation on how to install and use + scruf. diff --git a/README b/README index 724e656..40eb9d7 100644 --- a/README +++ b/README @@ -1,146 +1,26 @@ -scruf +scruf ===== scruf is a simple program that converts marked up files to corresponding valid HTML5 files. -The markup that is understood by scruf is called the "scruffy" -markup. To learn about the scruffy markup look at -manual/scruffy-markup.html file. +To learn/use scruf take a look at the documentation[1]. -To get the up to date information about scruf, visit its homepage[1]. +See the MANIFEST, to get acquainted with the code base. + +[1]: -[1]: http://nongnu.org/scruf/ License ======= -scruf is free software[2] and it is licensed under the GNU General -Public License version 3 or later. - -The COPYING file contains the full text of the GNU General Public -License version 3. - -[2]: http://www.gnu.org/philosophy/free-sw.html - -The style sheet, style.css, in styling/ is dedicated to the public -domain. - -Platform -======== - -At present scruf can be used in GNU/Linux based operating -systems. Since scruf is written in Java, it might work on other -platforms like Windows, Mac, etc. - -scruf was not test in platforms other than GNU/Linux, so it might not -work as it should in platforms other than GNU/Linux, even if it -compiles successfully. - -Dependencies -============ - -To compile and run scruf, the OpenJDK[3] is need. Instructions are -provided in manual/scruf-howto.html on how to install the JDK. - -[3]: http://openjdk.java.net - -Installation -============ - -The source has to be compiled with the `javac' command, with that, the -installation is done. For instruction on compiling the scruf source, -see manual/scruf-howto.html. - -Overview of the scruf source -============================ - -This section is for folks who wish to read/explore/hack/study/etc the -source code. - -* Run.java : This is entry point for scruf. It contains the `main' - function starts the nuts & bolts of scruf. - -* parser/ : This directory contains all the `Parsers' and - related classes. - - The 'Parser' interface is defined in Parser.java and all parsers - implement this interface. - - The functionality of a Parser is to convert a specific scruffy - markup into corresponding HTML5 element. For instance, the `Link' - parser converts scruffy marked up links into corresponding HTML5 - links; The `CodeBlocks' parsers looks for code blocks in the marked up - file and converts the block into a HTML5 code block. - - `ParserList' class contains a list of all parsers that is used to - convert a scruffy markup file to valid HTML5. - -* conversion/ : Contains classes responsible for traversing - directories looking for scruffy marked up files & feeding the marked - up files to a list of parsers to convert into HTML5 +scruf is licensed under the GNU General Public License version 3 or +later, see COPYING. - `ConvertDirectory' class recursively traverses a directories & when - it finds a scruffy marked up file, it gives it to the `ConvertFile' - class to perform HTML5 conversion. +The style sheet, style.css, in styling/ is in the Public Domain. - `ConvertFile' gets a scruffy marked up file and feeds the file to a - list of parsers to convert to HTML5 and writes the converted HTML5 - file to the disk. - + ignore/ : This directory contains a class which help identify - sub-directories that are to be ignored. - -* index/ : Contains the `IndexCreator' class which adds links to newly - converted HTML5 files to the directory's `index.scruffy' file - - `index.scruffy' is created in directories that have scruffy marked - up files and it contains a list of links to all the HTML5 files - converted by scruf. - -* io/ : Contains classes for reading/writing files. - -* status/ : Contains the `PresentFile' class which has the details - about the marked up file that is being converted to HTML5. - - The `DirectoryInfo' class has the `level' of the directory being - traversed with respect to the `root' directory. - - The `root' directory is the top level directory given by the user to - perform HTML5 conversion. - -* styling/ : This directory contains the StyleChecker class which - makes sure that every directory, that has a scruffy marked up file, - contains a dedicated style sheet -- style.css. - - The style.css is the default style sheet used by scruf. - -* docs/ directory: Contains documentation on how to install and use - scruf. - -Mailing List -============ - -All public discussion regarding the scruf project happens in the -scruf-friends[4] mailing list. - -If you want help or have issues using scruf or wish to contribute to -the scruf project or desire to give vent to your thoughts about scruf, -the scruf-friends[4] list is the right place. - -[4]: https://lists.nongnu.org/mailman/listinfo/scruf-friends - -Report a Bug -============ - -Found scruf has gone bonkers or it is not working the way it has to? -Just file a bug report[5] about it. Please also provide your contact -information if it is required. - -[5]: http://savannah.nongnu.org/bugs/?group=scruf&func=additem - -Author -====== +Contact +======= -scruf is authored & maintained by rsiddharth -. \ No newline at end of file +rsiddharth \ No newline at end of file -- cgit v1.2.3