geo

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

https://github.com/hungrybluedev/geo

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary

Keywords

v vlang vlang-cli
Last synced: 10 months ago · JSON representation ·

Repository

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

Basic Info
  • Host: GitHub
  • Owner: hungrybluedev
  • License: mit
  • Language: V
  • Default Branch: main
  • Homepage:
  • Size: 51.8 KB
Statistics
  • Stars: 11
  • Watchers: 4
  • Forks: 4
  • Open Issues: 0
  • Releases: 0
Topics
v vlang vlang-cli
Created over 4 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

Geo

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

GitHub tag (latest SemVer) CI

Motivation

👉 Accompanying blog posts: 1. The Complete Beginner’s Guide to CLI Apps in V 2. Elevate Your V Project With Unit Tests 3. 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. For a brief introduction to V, refer the article: 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 for more details.

Mirrors

This project is hosted on GitHub: hungrybluedev/geo

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

Contributors

  • @SheatNoisette - Idea, documentation, unit tests, and code improvement.
  • @hungrybluedev - Initial implementation, maintenance, and other chores.

Owner

  • Name: Subhomoy Haldar
  • Login: hungrybluedev
  • Kind: user
  • Location: United Kingdom
  • Company: @Coders-Compass

Experienced polyglot developer and published author specializing in full-stack systems, DevOps, and technical architecture.

Citation (CITATION.cff)

abstract: A sample CLI tool made in V that prints geometric shapes to the screen.
authors:
  - alias: hungrybluedev
    family-names: Haldar
    given-names: Subhomoy
cff-version: 1.2.0
date-released: 2023-04-20
license: MIT
message: Please cite this software using these information.
repository-code: https://github.com/hungrybluedev/geo
title: geo
url: https://github.com/hungrybluedev/geo
version: 0.2.5

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 1
  • Total pull requests: 2
  • Average time to close issues: 1 day
  • Average time to close pull requests: about 14 hours
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 1.5
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • SheatNoisette (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • docker://citationcff/cffconvert latest composite
  • docker://rhysd/actionlint latest composite
  • vlang/setup-v v1.3 composite