Skip to content

Latest commit

 

History

History
116 lines (86 loc) · 5.17 KB

README.md

File metadata and controls

116 lines (86 loc) · 5.17 KB

Aura

Build Status Version License: MIT

Aura is a powerful tool for C/C++ learners, designed to streamline the process of setting up and managing projects. With Aura, you can focus on learning and coding instead of dealing with repetitive tasks like creating folders, writing CMake files, or compiling manually.

About

Learning C/C++ and tired of manually managing files, folders, and compilation? Aura automates these tasks by:

  • Automated Project Initialization: Generate a professional-grade project structure complete with a CMakeLists.txt file.
  • Organized Folder Setup: Start every project with a clean, intuitive folder hierarchy.
  • Default .gitignore Integration: Avoid unnecessary clutter by including a pre-configured .gitignore file.
  • Seamless Library Management: Leverage built-in Conan support to easily integrate external libraries into your project.
  • Quick Environment Setup: Configure your entire C++ learning environment effortlessly with a single command.
  • Efficiency-Driven Commands: Simplify repetitive tasks to focus more on learning and building your C++ skills.

No more starting from scratch every time you want to learn a new concept in C/C++! 😊

Features

  • Automated Project Setup: Quickly generate a new C/C++ project structure.
  • Compilation Commands: Simplified commands for compiling and running code.
  • Integrated Unit Testing: Easily set up and run unit tests.
  • External Library Support: Add libraries using Conan package manager.
  • Build Automation: A single command to compile and run your project.
  • Cross-Platform Support: Works on Windows and Linux.
  • Package Management: Manage dependencies with ease.
  • GDB Debugger Integration: Debug your projects seamlessly.
  • Installer Creation: Generate packaged builds for distribution.
  • Update & Fix Commands: Keep Aura up-to-date and resolve installation issues.

Download the pre-build binaries for your platform or

Installation

Prerequisites

Ensure the following tools are installed on your system:

Steps

  1. Clone the repository:

    git clone https://github.com/vishal-ahirwar/aura.git
cd aura

  2. Build and install:

    • Linux: 
      ./build.sh
sudo make install
    • Windows: 
      build.bat

Usage

Run Aura with the following syntax:

aura [command] projectname

Available Commands

Command Description
create Create a new C/C++ project. Example: aura create myProject
compile Compile the project. Example: cd myProject && aura compile -DCMAKE_BUILD_TYPE=Debug
run Run the compiled binary. Ensure the project is compiled first.
build Compile and run the project in a single step.
setup Install g++ and cmake on your system (if not already installed).
utest Enable unit testing. Example: aura create test --test
createinstaller Create a packaged build of your application.
update Update Aura to the latest version.
add Add an external library using Conan. Example: aura add fmt/11.0.2
reload Reload the package list. Example: aura reload.
initconan Add a Conan configuration file to the project.
debug Start the GDB debugger for your project.
release Compile the application in release mode. Example: aura compile -DCMAKE_BUILD_TYPE=Release.
fix Fix Aura installation issues.

Author

Developed by Vishal Ahirwar.
Copyright © 2024 Vishal Ahirwar and all Contributors. All rights reserved.

License

This project is licensed under the MIT License. See the LICENSE file for details.