Run

Run is a windows CLI package manager with basic commands shortened to conditional flags. It is build using pnpm

Motive
Tech-Stack
Installation
Why pnpm?
Rules
Commit-Message-Format
License
Support

Motive

The motive of building Run is to create a package manager with commands as short as possible and easy to remember. Run using pnpm to manage and run the project while shortening its commands only to conditional flags.

Tech-Stack

The tech stacks for building this CLI is listed below. More stacks are to be used which will be decided during the course of development.

c++
pnpm

Installation

To start with the installtaion it is recommended to have Git, pnpm and g++ compiler installed in the system. Follow the respective docs for their installation

step 1(optional): Check pnpm and g++ installation

pnpm --version
## output: 9.0.0 or above

g++ --version
# g++ (Rev6, Built by MSYS2 project) 13.2.0 or above
# Copyright (C) 2023 Free Software Foundation, Inc.
# This is free software; see the source for copying conditions.  There is NO
# warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

step 2: Clone the repository and move to the directory

git clone https://github.com/pratham-ak2004/Run
cd Run

step 3: Add project to your system path. This is to run the executable after building it.

step 4: Build from .cpp file

g++ run.cpp -o run.exe

Why pnpm?

We are using pnpm for this CLI because it have readable output messages and generates lock file in .yaml format which is easy to interpret.

Rules

some rules for contributions

Follow the commit message format as mentioned in the next section
Use meaningful names for identifiers while working on the project

Commit-Message-Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope is optional

Type

Your commit message should be one of the following types:

feat: A new feature.
fix: A bug fix.
docs: Documentation only changes.
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
refactor: A code change that neither fixes a bug nor adds a feature.
perf: A code change that improves performance.
test: Adding missing tests.
chore: Changes to the build process or auxiliary tools and libraries such as documentation generation.