Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 2.07 KB

README.md

File metadata and controls

48 lines (34 loc) · 2.07 KB

printo

printo (pronounced "print-o") is a Nim package that can be used to configure the timing of printing text on the terminal. There are 4 different modes to choose from. Printo can be used in any Nim application that supports version 1.6.14 and above.

However, since printo is a simple library that uses only basic Nim constructs, applications written in earlier versions of Nim should also be able to use it seamlessly.

How to use printo

Installation

Since printo has not yet been added to the nimble directory, you'll have to install it from the repository.

$ nimble install https://bitbucket.org/pyfyclan/printo.git

After it is installed, add the printo to your project's .nimble file using the requires keyword:

requires "printo >= 0.1.0"

Then, using printo in your project is quite easy. You can import printo into any file within your project. There is only one proc that you actually use: printo. Just import that proc and you are good to go; really.

The printo proc only requires three arguments to work:

  1. The text to be printed.
  2. The mode of printing (detailed below).
  3. The time (in milliseconds) gap between each element while printing. An element could be a word or a character.

Modes

Currently, printo supports four modes of printing. They are detailed in the following table:

Mode Description
lblsl Print text letter by letter on the same line.
wbwsl Print text word by word on the same line.
lblnl Print text letter by letter on a new line per letter.
wbwnl Print text word by word on a new line per word.

The actual usage is as follows:

from printo import printo

let txt: string = "Lorem ipsum whatever you got."
let mode = "lblsl"
let time = 100  # remember that this value is in milliseconds

printo(txt, mode, time)