Lib.rs

About The Project

ProjectOrganzier is a tool to help speedup the process or creating and organizing projects. By default, only an empty folder with the project name will be created, but you can specify different options to populate the project folder. One option is to clone and exiting git remote, or you can specify different templates to use.

(back to top)

Built With

• Rust
• Clap

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Optional - Cargo
  • https://rustup.rs/
  • This makes the installation process much easier, but is optional

Installation

Option 1 - Easier Method

1. Install the cargo crate directly from GitHub

   cargo install --git https://github.com/Frazzer951/ProjectOrganzier.git
   

   To install a specific release version use --tag <VERSION TAG>

Option 2 - Manual Install

1. Download the binary from the latest release for your platform from the release page
2. Place the binary into a folder seen by your OSes PATH variable, so it can be called from anywhere

(back to top)

Usage

Basic usage can be seen by looking at the help information for each command

ProjectOrganzier -h

To add a simple project use

ProjectOrganzier new -n MyProjectName

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes using Conventional Commits (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request to the develop branch

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Luke Eltiste - luke343279@gmail.com

Project Link: https://github.com/frazzer951/ProjectOrganzier

(back to top)