Permalink
Browse files

Added updated documentation and switched the format to prettier markdown

  • Loading branch information...
1 parent 9d22fb7 commit db55408fade06865ca89f3cf41fd98068e7be2a3 @mephraim committed Apr 9, 2010
Showing with 51 additions and 36 deletions.
  1. +0 −36 README
  2. +51 −0 README.md
View
36 README
@@ -1,36 +0,0 @@
-GhostscriptSharp
-================
-
-GhostscriptSharp is a simple C# wrapper for the Ghostscript library.
-
-
-Using GhostscriptSharp
-======================
-
-The GhostscriptWrapper class contains 2 static methods that can be used to generate jpg images from a PDF file.
-
-* GeneratePageThumb(string inputPath, string outputPath, int page, int width, int height)
-
-- Generates a thumbnail from a single page of the target PDF
-
-= Parameters
-
--- inputPath = a path to the PDF file
--- outputPath = the path where you would like the output jpg
--- page = the page number for the page you want to create an image from
--- width = the width of the image
--- height = the height of the image
-
-* GeneratePageThumbs(string inputPath, string outputPath, int firstPage, int lastPage, int width, int height)
-
-- Generates a collection of thumbnail jpgs for the PDF at the input path, starting with firstPage and ending with lastPage.
-
-= Parameters
-
--- inputPath = a path to the PDF file
--- ouputPath = the path where you would like the output jpgs to go (put '%d' somewhere in the path to have the jpgs numbered)
--- firstPage = the first page to start generating the thumbnails from
--- lastPage = the last page to end the thumbnail generator
--- width = the width of the image
--- height = the height of the image
-
View
@@ -0,0 +1,51 @@
+# GhostscriptSharp
+GhostscriptSharp is a simple C# wrapper for the Ghostscript library.
+
+# Using GhostscriptSharp
+The GhostscriptWrapper class contains 3 static methods that can be used to generate jpg images from a PDF file.
+
+## Generate an Image for a Single Page
+
+This method will generate a single thumbnail for a single page at the given output path
+
+`GeneratePageThumb(string inputPath, string outputPath, int page, int width, int height)`
+
+### Parameters
+
+* **inputPath** _a path to the PDF file_
+* **outputPath** _the path where you would like the output jpg_
+* **page** _the page number for the page you want to create an image from_
+* **width** _the width of the image_
+* **height** _the height of the image_
+
+## Generate Multiple Images for Multiple Pages
+
+This method generates a collection of thumbnail jpgs for the PDF at the input path, starting with firstPage and ending with lastPage.
+Put "%d" somewhere in the output path to have each of the pages numbered.
+
+`GeneratePageThumbs(string inputPath, string outputPath, int firstPage, int lastPage, int width, int height)`
+
+### Parameters
+
+* **inputPath** _a path to the PDF file_
+* **ouputPath** _the path where you would like the output jpgs to go (put '%d' somewhere in the path to have the jpgs numbered)_
+* **firstPage** _the first page to start generating the thumbnails from_
+* **lastPage** _the last page to end the thumbnail generator_
+* **width** _the width of the image_
+* **height** _the height of the image_
+
+## Generate Output Based on Settings
+
+This method generates Ghostscript output at the given output path based on a collection of GhostscriptSettings.
+(See the source for a list of possible settings)
+
+`GenerateOutput(string inputPath, string outputPath, GhostscriptSettings settings)`
+
+### Parameters
+
+* **inputPath** _a path to the PDF file_
+* **outputPath** _the path where you would like the output jpg_
+* **settings** _a collection of settings for the output (see source for more details)_
+
+
+

0 comments on commit db55408

Please sign in to comment.