diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000000..f5cdf9613b1e --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +<div align="center"> + <img src="/kookienomicon/plain/docs/logo.png" width="256px"/> + <h1>kookienomicon</h1> +</div> + + +Welcome to the *kookienomicon*, my personal project archive. Here you +will find tools, libraries, and prototypes that I have written in the +hopes that they might one day be useful to future-me, or future-you. + +Be warned though, there's software ahead ~✨ + + +## Structure + +Following is an overview of components in this repository. + +| Directory | Description | +|-------------|--------------------------------------------------------------------------------| +| apps | Applications (graphical and command-line) meant for end-users | +| development | Libraries and specific tools primarily meant to be used by software developers | +| docs | Documentation for the kookienomicon | +| infra | Personal infrastructure projects (namely `libkookie` & my website) | +| junkyard | Projects I've abandoned and that are considered read-only archives | +| licenses | Set of license texts in use by projects in this repository | + + +## Working with a large repo + +This repository is quite massive, because it contains multiple +subtrees with large histories. + +If you experience performance problems, try setting +`feature.manyFiles` in your git configuration. Additionally, when +using `git log`, make sure to use `--first-parent` to get the history +of kookienomicon, instead of the merged subtree histories. + + +## License + +This repository has no unified license. Check each project for it's +specific license. Licenses in-use by projects in this repository can +be found in the `licenses` directory. |