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 2022-11-30 11:18:18 +00:00 committed by GitHub
parent d6d4319e21
commit 2b246df25d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,10 +1,28 @@
# MediaTool
# NotesTK
This is a collection of tools and apps for working with various media (Web, Desktop Publishing, Video/Audio) on different platforms (Linux, Windows).
Notes Toolkit (NotesTK) is a set of tools for building applications focused on taking and organising notes, like study or research materials.
It tries to have low dependencies and lots of things are built from scratch.
## Project Goals
This is a personal/hobby project - things will break/change a lot.
* Cross-platform - Currently targets Linux and Windows, Mac is planned.
* Low dependencies - Depends on as few third-party libraries as possible.
* Clean licensing - APIs may be similar to other libraries for compatibility but implementations are built from scratch.
* Code re-use - If distinct areas depend on a similar routine implement it only once.
## Project Status
The codebase is at a very early/prototype stage and under heavy active development. It is strongly recommended to only use it as a reading reference. Expect:
* No Docs or tagged releases
* Misleadingly named and broken APIs
* Large commits and significant breaking changes
* Naive/low-performance implementations of things that haved worked just fine in other libraries for years
The only currently recommended use case is if you are implementing some element of the library functionality, have exhasuted existing online tutorials and want to see how someone else has tackled it (bearing in mind the copyleft licensing below).
## License
This project is dual-licensed under the copyleft AGPL with a commercial licensing option. If using this code in your own project make sure you are aware of the implications of copyleft and AGPL. See the `LICENSE` file in this repository for more details, including contact details.
# Build Dependencies