https://github.com/hungrybluedev/geo

A sample CLI tool made in V that prints geometric shapes to the screen.
https://github.com/hungrybluedev/geo

v vlang vlang-cli

Last synced: about 5 hours ago
JSON representation

A sample CLI tool made in V that prints geometric shapes to the screen.

• Host: GitHub
• URL: https://github.com/hungrybluedev/geo
• Owner: hungrybluedev
• License: mit
• Created: 2021-12-16T07:52:24.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-02T05:47:16.000Z (11 months ago)
• Last Synced: 2024-05-02T02:54:27.226Z (6 months ago)
• Topics: v, vlang, vlang-cli
• Language: V
• Homepage:
• Size: 51.8 KB
• Stars: 11
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# Geo

A sample CLI tool made in V that prints geometric shapes to the screen.

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/hungrybluedev/geo?sort=semver)](https://github.com/hungrybluedev/geo/tags)

[![CI](https://github.com/hungrybluedev/geo/actions/workflows/ci.yml/badge.svg)](https://github.com/hungrybluedev/geo/actions/workflows/ci.yml)

## Motivation

> 👉 Accompanying blog posts:

> 1. [The Complete Beginner’s Guide to CLI Apps in V](https://blog.vlang.io/the-complete-beginners-guide-to-cli-apps-in-v/)

> 2. [Elevate Your V Project With Unit Tests](https://blog.vlang.io/elevate-your-v-project-with-unit-tests/)

> 3. [Setting Up GitHub Actions for V](https://blog.vlang.io/setting-up-github-actions-for-v/)

This project is meant to be a demonstration showcasing how

easy it is to make a good CLI application with V. There is

also an example to how to effectively structure a V

project with modules and conduct unit tests.

## Prerequisites

Instructions for installing the V language can be found

[here](https://github.com/vlang/v/blob/master/doc/docs.md#install-from-source).

For a brief introduction to V, refer the article:

[Getting Started with V](https://blog.vlang.io/getting-started-with-v/).

Make sure to do `v up` to download and update to the latest version of V.

## Usage

You can use `v run . [OPTIONS]` to run the tool while

developing it. If you want a production build, you can use `v -prod .`, which will generate a binary file `geo` (or `geo.exe` on Windows) at the root of the repository.

To get started, try `./geo --help`. It will print the

following usage guide:

```

geo 0.2.x

-----------------------------------------------

Usage: geo [options] [ARGS]

Description: A sample CLI app for printing geometric shapes to the terminal.

Options:

  -p, --shape       The shape to use for the geometry.

                            Allowed shapes are: left-triangle, right-triangle, pyramid, square, diamond

  -z, --size           The size parameter for the shapes.

  -m, --symbol      The symbol to use for the geometry.

  -h, --help                display this help and exit

  --version                 output version information and exit

```

## Run Unit Tests

To run units tests, run this command at the root of this repository:

```

v test .

```

## License

This work is licensed under the MIT license, see [LICENSE](/LICENSE) for more details.

## Mirrors

This project is hosted on GitHub:

[hungrybluedev/geo](https://github.com/hungrybluedev/geo)

As a backup, this repository is also available on Codeberg:

[hungrybluedev/geo](https://codeberg.org/hungrybluedev/geo)

## Contributors

- [@SheatNoisette](https://github.com/SheatNoisette) - Idea, documentation, unit tests, and code improvement.

- [@hungrybluedev](https://github.com/hungrybluedev) -

  Initial implementation, maintenance, and other chores.