Skip to content

aardappel/treesheets

Repository files navigation

TreeSheets is a "hierarchical spreadsheet" that is a great replacement for spreadsheets, mind mappers, outliners, PIMs, text editors and small databases.

Suitable for any kind of data organization, such as todo lists, calendars, project management, brainstorming, organizing ideas, planning, requirements gathering, presentation of information, etc.

It's like a spreadsheet, immediately familiar, but much more suitable for complex data because it's hierarchical. It's like a mind mapper, but more organized and compact. It's like an outliner, but in more than one dimension. It's like a text editor, but with structure.

Community:

If you like, you are kindly invited to join the Discord channel and the Google group for discussion.

Installation:

Windows/Ubuntu LTS/MacOS users

Pre-built binaries are available at the Release section.

Please note that the Linux builds provided are built and only compatible with ubuntu-latest used by GitHub Actions Runner.

Flatpak (Linux) users

If you use Flatpak, you can install TreeSheets from Flathub.

Source Code:

This repository contains all the files needed to build TreeSheets for various platforms.

License

TreeSheets has been licensed under the ZLIB license (see ZLIB_LICENSE.txt).

Workflow status

Structure

src contains all source code. The code is dense, terse, and with few comments, typical for a codebase that was never intended to be used by more than one person (me). On the positive side, you'll find the code very small and simple, with all functionality easy to find and only in one place (no copy pasting or over-engineering). Enjoy.

TS is the folder that contains all user-facing files, typically the build process results in an executable to be put in the root of this folder, and distributing to users is then a matter of giving them this folder.

TODO.txt is the random notes I kept on ideas of myself and others on what future features could be added.

Building:

Note that YOU are responsible to know how to use compilers and C++, the hints below are all the help I will give you:

Windows

  1. TreeSheets requires the latest development wxWidgets from their repo: git clone --recurse-submodules https://github.com/wxWidgets/wxWidgets.git.
  2. Make sure your wxWidgets folder sits parallel to the src folder, that way the TreeSheets project will pick it up without further modifications
  3. Inside wxWidgets/build/msw, open wx_vc17.sln with Visual Studio 2022.
  4. Select all projects (except the project _custom_build) in the solution explorer, and go to properties:
    • Set configuration to debug, and C/C++ -> Code Generation -> Runtime library to Multithreaded Debug
    • Set configuration to release, and C/C++ -> Code Generation -> Runtime library to Multithreaded
  5. Build solution in both x64 Debug and Release
  6. Close the wxWidgets solution
  7. win contains the Visual Studio 2022 files for treesheets, open the .sln. If you've done the above correctly, TreeSheets will now compile and pick up the wxWidgets libraries.
  8. To distribute, build an installer with win\TS_installer.nsi (requires nsis.sourceforge.net)

Mac OS

  1. Clone this repository
git clone https://github.com/aardappel/treesheets
  1. Change to working tree
cd treesheets
  1. Configure the build system
cmake -S . -B _build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/Applications
  1. Build
cmake --build _build -j
  1. Install
cmake --install _build

Linux

  1. Clone this repository
git clone https://github.com/aardappel/treesheets
  1. Change to working tree
cd treesheets
  1. Configure the build system
cmake -S . -B _build -DCMAKE_BUILD_TYPE=Release
  1. Build
cmake --build _build -j
  1. Install
sudo cmake --install _build

Further information for Mac OS / Linux

  • If you have git installed, the submodules for wxWidgets will be automatically updated and wxWidgets will be compiled as a CMake subproject. TreeSheets will be then statically linked against this wxWidgets build.
  • If you do like to link dynamically against an existing wxWidgets installation instead, you can switch off the option GIT_WXWIDGETS_SUBMODULES in the CMake project. In this case:
    • You can use the version of wxWidgets from https://github.com/wxWidgets/wxWidgets.git.
    • Follow the instructions to build there, but add --enable-unicode and --disable-shared to the configure step.
    • Alternatively you can build against the wxWidgets package of your distribution.
  • You can change the default installation prefix (/usr/local) by passing something like -DCMAKE_INSTALL_PREFIX=/usr.
  • If you are MacOS X user, a bundle will be installed to the installation prefix.

Contributing:

I welcome contributions, especially in the form of neatly prepared pull requests. The main thing to keep in mind when contributing is to keep as close as you can to both the format and the spirit of the existing code, even if it goes against the grain of how you program normally. That means not only using the same formatting and naming conventions (which should be easy), but the same non-redundant style of code (no under-engineering, e.g. copy pasting, and no over engineering, e.g. needless abstractions).

Also be economic in terms of features: treesheets tries to accomplish a lot with few features, additional user interface elements (even menu items) have a cost, and features that are only useful for very few people should probably not be in the master branch. Needless to say, performance is important too. When in doubt, ask me :)

Try to keep your pull requests small (don't bundle unrelated changes) and make sure you've done extensive testing before you submit, preferrably on multiple platforms.

Stars over time:

Stargazers over time