Skip to content

spirometaxas/hexaflake-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hexaflake-cli

Print the Hexaflake fractal to the console!

What hexaflake-cli prints to the console

npm version bundle size downloads license

Why the console? Because it's the cool way.

See All Fractals in the fractals-cli project.

Usage

Via npx:

$ npx hexaflake-cli <n>
$ npx hexaflake-cli <n> [size] [options]

where n >= 0 and size >= n (if provided).

Via Global Install

$ npm install --global hexaflake-cli
$ hexaflake-cli <n>
$ hexaflake-cli <n> [size] [options]

where n >= 0 and size >= n (if provided).

Via Import

$ npm install hexaflake-cli

then:

const hexaflake = require('hexaflake-cli');
console.log(hexaflake.create(<n>));
console.log(hexaflake.create(<n>, { 
    size: <number>, 
    character: <character> 
}));

The config params are optional.

Options

Recursive Step

$ hexaflake-cli <n>

The first param <n> is the recursive step. <n> should be an integer greater than or equal to 0.

Examples:

$ hexaflake-cli 2

What hexaflake-cli prints to the console

$ hexaflake-cli 3

What hexaflake-cli prints to the console

Size

$ hexaflake-cli <n> [size]

The optional [size] param allows the Hexaflake to be drawn at larger sizes. [size] should be an integer greater than or equal to <n>. Including size will draw a Hexaflake of <n> recursive steps the size of a hexagon with [size] recursive steps.

Example:

$ hexaflake-cli 2 3

What hexaflake-cli prints to the console

Custom Characters

$ hexaflake-cli <n> --character=<character>

The optional --character=<character> param will draw hexagons using the provided character. (Please provide only 1 character)

Example:

$ hexaflake-cli 1 3 --character=*

What hexaflake-cli prints to the console

Related

Main Project

Fractal Shapes

Fractal Patterns

Space Filling Curves

License

About

Print the Hexaflake fractal to the console!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published