stephenlhern / fons

An intuitive, cross-platform tool for working with git written in C++

Fons

Short for fons et origo, fons is an intuitive, cross-platform tool for working with git written in C++.

Status

Fons is currently under active development, the current code serves as a proof-of-concept for the tool and a mechanism to experiment with different features, and prototype ideas.

Roadmap

Below is a roadmap for the planned scope of the project:

Completed

☑️ Proof of concept

• wxWidgets GUI for browsing repository commits, branches
• Command manager supporting libgit2, filesystem operations on separate threads from GUI
• Application settings framework, example setting
• Doxygen, Sphinx documentation
• Unit test suite
• Github API, Merge Request management

To Do

🔲 Architecture backlog

• Installer
• Create customized controls for branch, repository selection, easy text search
• Expand Command, Command Manager support for:
  • Blocking commands on specified resources
  • Event signaling command completion, cancellation
• OSX, Linux builds, testing

🔲 Basic git operation support

• Init, Clone Repositories
• Create, Read, Update, Delete Branches
• Create, Amend, Push commits
• Pull, Fetch support
• Repository file browsing
• Manage Changes in Working Directory, Staging Directory, Repository
• Cherry-pick support
• Git settings support
• Git user account support

🔲 Advanced git operation support

• Granular checkout support
• Granular diff support
• Visual stash management
• Interactive rebase
• Conflict Resolution
• Search Repository (by commit ID, user, branch, filenames, file content)
• Enhanced command line prompt for git commands

🔲 GitHub, GitLab, Bitbucket support

• Repository, User icon support
• Merge Request management

License

All code developed for fons is available under the MIT license for use in all other pojects, further details are provided in the license file.

Developer Documentation

Documentation for the underlying source code is hosted on Read the Docs, and can be found at fons.readthedocs.io.

Credits

Fons makes use of the following libaries, tools, and resources (listed alphabetically):

• cereal
• Cmake
• cpr
• Doxygen
• Github
• JSON for Modern C++ (nlohmann-json)
• libgit2
• Octicons
• ReadTheDocs
• Sphinx
• vcpkg
• wxWidgets

Full license information for these libraries are available at the provided websites, and is also included in the fons application info page text.

Additional Thanks to (listed alphabetically):

• indi, stack exchange code reviews
• Pavel Boev, cereal-optional code
• Sy Brand, documentation tutorial for sphinx/doxygen/read the docs

fons's Issues

Build this project under msys2/mingw64 environment

Hi, I'm not sure, it looks like this project is built under MSVC. But I'm hoping this project could also be built under MinGW.

It looks like some of the dependencies are already be built/supplied under msys2:

• Package: mingw-w64-x86_64-cereal - MSYS2 Packages
• Package: mingw-w64-x86_64-libgit2 - MSYS2 Packages
• Base Package: mingw-w64-wxwidgets3.2 - MSYS2 Packages

Thanks.