Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.42 KB

README.md

File metadata and controls

74 lines (46 loc) · 2.42 KB
Raw

Planetary - A P Language Build Manager

Planetary is a command-line tool designed to simplify the management and building of P projects. It provides a streamlined approach to initializing, templating, and checking P projects, making it easier to get started on a project right away.

Features

  • Project Initialization: Quickly set up a new P project with the necessary directory structure and configuration files.
  • Template Generation: Create a template for an existing P project, allowing for consistent project organization.
  • Error Checking: Perform basic error checking on P projects to identify potential issues early on.
  • User-Friendly Interface: Simple and intuitive command-line interface for ease of use.

Installation

  1. Prerequisites: Ensure you have the following installed:

    • OCaml
    • Dune

  2. Build and Install:

    dune build @install

Usage

Planetary - P Language Project Manager

Usage:
  planetary init <project_name> [-s <folder>] - Initialize a new P project
  planetary template <project_name> - Generate a template for an existing project
  planetary help - Display this help message

Options:
  -s <folder> - Skip creating the specified folder (can be used multiple times)

Examples

  • Initialize a new project named "TCP":

    planetary init TCP

    Planetary should generate all the folders necessary as well as a PProj file for you to get started:

    image image

  • Generate a template for an existing project named "TCP":

    You can also use Planetary to generate a .PProj file for existing projects:

    planetary template existing_project
    image
    • Note: There's a bug where this command only works when executed from a directory above the existing project. A fix for this should be coming soon.

  • Initialize a project while skipping the PSPEC folder:

    planetary init my_p_project -s PSPEC

Contributing

Contributions are welcome! Please feel free to open issues or submit pull requests.