From 595c30382b0047a50146972e38dd7419ca15e14b Mon Sep 17 00:00:00 2001 From: VirtualWolf Date: Tue, 13 Mar 2018 00:15:01 +1100 Subject: [PATCH] Minor typo and wording fixes in README (#178) * Minor typo and wording fixes in README. * More wording tweaks. --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 222a4e4..1fac8de 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ text.Clear() ```python from papirus import PapirusTextPos -# Calling PapirusTextPos this way will mean nothing is written to the screen be default +# Calling PapirusTextPos this way will mean nothing is written to the screen by default text = PapirusTextPos(False [,rotation = rot]) # Write text to the screen at selected point, with an Id @@ -161,8 +161,8 @@ text.WriteAll() # No change will happen on the screen text.UpdateText("Start", "New Text") -# Remove The second line of text -# The text won't be removed just yet from the screen +# Remove the second line of text +# The text won't be removed from the screen yet text.RemoveText("Top") # Now update the screen to show the changes @@ -185,7 +185,7 @@ text.AddText("hello world", 10, 10, Id="Start", invert=True) PapirusTextPos will take into account \n as a line break (or multiple line breaks) Meaning text will be aligned to the X position given, it will not return to x=0 for the start of the next line. -WHen the text is longer than will fit on a single line, PapirusTextPos will break the text in multiple lines. +When the text is longer than will fit on a single line, PapirusTextPos will break the text into multiple lines. You can limit the number of lines by specifying the parameter `maxLines` in the `AddText()` method. When using the PapirusTextPos, in either mode, setting the "partialUpdates" property to True will cause partial updates to be done, meaning only the section of the PaPiRus screen that has been changed will be updated. These can be vastly quicker than a full update for each piece of text. @@ -236,7 +236,7 @@ textNImg.AddImg("/path/to/image",20,20,(25,25), Id="BigImg") # Nothing will show on the screen textNImg.AddImg("/path/to/image", Id="Top") -# Now display all elements on the scrren +# Now display all elements on the screen textNImg.WriteAll() # Update the first line @@ -248,7 +248,7 @@ textNImg.UpdateText("Start", "New Text") textNImg.UpdateImg("BigImg", "/path/to/new/images") # Remove top image -# The images won't be removed just yet from the screen +# The images won't be removed from the screen yet textNImg.RemoveImg("Top") # Now update the screen to show the changes @@ -331,13 +331,13 @@ papirus-twitter # Composite text and graphics papirus-composite-write -# Copy framebuffer (text console or desktop) to Papirus using the buttons to zoom en pan +# Copy framebuffer (text console or desktop) to PaPiRus using the buttons to zoom and pan # Only for 2.7" and 2.0" displays papirus-fbcopy -# Display image sequences or slide-show -# The directory containing the pictures must have number sequenced images in the form 0.gif, 1.gif, 2.gif, etc. -# for an animation or pictures with random names (e.g. in the case of a slide-show). +# Display image sequences or slideshow +# For an animation, the directory containing the images must have numbered images in the form 0.gif, 1.gif, 2.gif, etc. +# Otherwise the images will be displayed in filename order. papirus-animation [--delay DELAY] [--rotation ROTATION] [--fullupdate] [--loop] directory # Take a picture with the RPi camera using the PaPiRus screen as viewfinder @@ -345,9 +345,9 @@ papirus-animation [--delay DELAY] [--rotation ROTATION] [--fullupdate] [--loop] papirus-cam ``` -### Demos for using the Real Time Clock of the Papirus HAT +### Demos for using the Real Time Clock of the PaPiRus HAT -The Papirus HAT has a battery backed-up Real TIme Clock. For more information about the RTC and demos see the +The PaPiRus HAT has a battery backed-up Real Time Clock. For more information about the RTC and demos see the [RTC-Hat-Examples](./RTC-Hat-Examples) directory and README files. ### Tips for using images