README.md

HummingBird C++ Project

An innovative toolkit for software development!
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Important Note:

a lot of the code is still in development and is not ready for production use. alot of windows are half functional and some are not even implemented yet. Also this is my first c++ project so the code is not the best and i am still learning c++ so if you have any tips or tricks please let me know.

Important Note 2:

This project is developed for Mac x86-64 architecture . I have not tested it on any other platform. I am planning to make it cross platform but i am not sure when that will happen.

Important Note 3:

I still need to find some licences for some of the code I used. Please if you find any code that is not properly licensed let me know so i can fix it!

About The Project

The HummingBird C++ Project is a comprehensive suite of development tools, including a core library and various applications for software development and automation tasks. It's designed to be modular and flexible, catering to a wide range of development needs.

Built With

This project is built using a variety of technologies:

• C++
• [SDL2] og:(https://www.libsdl.org/) my fork:(https://github.com/kasperhbo/SDL) --> branch 2-28.x
• [Glad] og:(https://glad.dav1d.de/) my fork:(https://github.com/kasperhbo/Glad) --> branch master
• [Fmt] og:(https://fmt.dev/latest/index.html) my fork:(https://github.com/kasperhbo/fmt) --> branch master
• [Spdlog] og:(https://github.com/gabime/spdlog) my fork:(https://github.com/kasperhbo/spdlog) --> branch v1.x
• [Imgui] og:(https://github.com/ocornut/imgui) my fork (make sure to use mine when cloning because it contains my own and others widgets):(https://github.com/kasperhbo/imgui) --> branch docking
• [mysql8.2-client] og:(https://dev.mysql.com/downloads/)
• [libxml2]og:(https://github.com/GNOME/libxml2)

(back to top)

Getting Started

To get started with the HummingBird project, follow these simple steps.

Prerequisites

At the moment only tested on an Intel Mac running macOS Montery 12.7.1, it is not tested on anything else. Ensure you have git installed to clone the repository: Check in your terminal with:

git --version

Installation

Deps

Hummingbird

1. Clone the HummingBird repository:

   git clone https://github.com/KaspersCult/HummingBird.git --recursive 

2. go in the folder:

    cd HummingBird

3. init and update the submodules:

    git submodule update --init --recursive

4. create a build folder and go in it:

   mkdir build && cd build

5. run cmake:

    cmake DCMAKE_BUILD_TYPE=Debug -G "CodeBlocks - Unix Makefiles" -S ../

6. run make with the number of cores:

    cmake --build . --target HummingbirdCoreEXE -- -j $(sysctl -n hw.ncpu)

7. run the executable:

    ./HummingbirdCoreEXE

(back to top)

Usage

Use HummingBird for developing applications, creating tools, or automating tasks. For more specific examples, please refer to the Documentation.

(back to top)

Roadmap

Application

Roadmap

• Core library for basic functionalities
• Application for text editting -- finished
• Host edittor -- in dev
• Plist launchd editor
• Integrated VNC viewer
• Terminal rewrite
• Java build tool integration
• Creating custom scripts to run your commands

In progress

• Plist launchd editor
• Cleaning up cmake list

Documentation

• All the rest of the documentation lol
• Proper build documentation

Platfroms

• Mac OsX Intel 12.1.7
• Mac OsX with an: M1/M2/M3
• Debian OS
• Ready for whatever Windows throws at us next – Windows 11, 12, 13, or even 68.

See the open issues

(back to top)