jgrogan/stuff-from-scratch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
James Grogan 2024-02-02 10:29:59 +00:00 committed by GitHub
parent 3dce256213
commit 849d8d8ca2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -1,61 +1,14 @@
# NotesTK # Stuff From Scratch
Notes Toolkit (NotesTK) is a set of tools for building applications focused on taking and organising notes, like study or research materials. This is a hobby-repo I use for learning about different software technologies by trying to build stuff from scratch.
## Project Goals It covers a bunch of areas:
* Cross-platform * Build tooling
* Low third-party dependencies * Audio and Video
* Permissive licensing * 3D modelling
* Simplicity over performance * Desktop window management and UIs
## Project Status Nothing here should be used in a real project :)
🚨🚨🚨 The codebase is at a very early/prototype stage and under heavy active development🚨🚨🚨
In addition to feature development I've been using it to get up-to-speed on various media formats and desktop and rendering APIs. It is strongly recommended to only use it as a reading reference.
Expect:
* No Docs or tagged releases
* Large commits and significant breaking changes
* Unreliable/untested APIs
* Naive/low-performance implementations
The only currently recommended use case is if you are implementing some element of the library functionality and want to see how someone else has tackled it, maybe you will see something useful.
# Building
Many project features (e.g. Wayland integration) only build if suitable third-party dependencies are found on the system, otherwise they will be automatically disabled. You can find dependency requirements in the `README.md` file in each module's `src`directory.
A minimal set of dependencies for each platform are included below.
## Linux
Install dependencies:
```bash
sudo apt-get install build-essential pkg-config cmake
```
Build:
```bash
mkdir build
cd build
cmake $PATH_TO_SOURCE
make
apps/$NAME_OF_APP
```
## Windows
Tested with Visual Studio 17 with 'Desktop Development with C++' tooling, including ATL and Windows SDK 10 (10.0.19041.0). Additionally, install `cmake`.
```bash
mkdir build
cd build
cmake $PATH_TO_SOURCE
```
You can open the resulting `NotesTK.sln`in Visual Studio and build.