diff options
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/SUMMARY.md | 32 | ||||
| -rw-r--r-- | docs/src/concepts/allocators.md | 1 | ||||
| -rw-r--r-- | docs/src/concepts/context.md | 1 | ||||
| -rw-r--r-- | docs/src/concepts/normalisation.md | 1 | ||||
| -rw-r--r-- | docs/src/concepts/streams.md | 1 | ||||
| -rw-r--r-- | docs/src/contributing/contributing.md | 1 | ||||
| -rw-r--r-- | docs/src/contributing/stewardship.md | 1 | ||||
| -rw-r--r-- | docs/src/formats/png.md | 1 | ||||
| -rw-r--r-- | docs/src/getting-started/building.md | 1 | ||||
| -rw-r--r-- | docs/src/getting-started/first-image.md | 1 | ||||
| -rw-r--r-- | docs/src/introduction.md | 36 |
11 files changed, 77 insertions, 0 deletions
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 0000000..948cceb --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,32 @@ +# tinyff + +[welcome](introduction.md) + +--- + +# getting started + +- [building tinyff](getting-started/building.md) +- [your first image](getting-started/first-image.md) + +--- + +# behind the scenes + +- [the context](concepts/context.md) +- [bring your own allocator](concepts/allocators.md) +- [streaming](concepts/streams.md) +- [normalisation and generics](concepts/normalisation.md) + +--- + +# supported formats + +- [png](formats/png.md) + +--- + +# join the project + +- [format stewardship](contributing/stewardship.md) +- [contributing](contributing/contributing.md)
\ No newline at end of file diff --git a/docs/src/concepts/allocators.md b/docs/src/concepts/allocators.md new file mode 100644 index 0000000..4523737 --- /dev/null +++ b/docs/src/concepts/allocators.md @@ -0,0 +1 @@ +# bring your own allocator diff --git a/docs/src/concepts/context.md b/docs/src/concepts/context.md new file mode 100644 index 0000000..8e22f03 --- /dev/null +++ b/docs/src/concepts/context.md @@ -0,0 +1 @@ +# the context diff --git a/docs/src/concepts/normalisation.md b/docs/src/concepts/normalisation.md new file mode 100644 index 0000000..a21955b --- /dev/null +++ b/docs/src/concepts/normalisation.md @@ -0,0 +1 @@ +# normalisation — one format to rule them all diff --git a/docs/src/concepts/streams.md b/docs/src/concepts/streams.md new file mode 100644 index 0000000..0e1aacc --- /dev/null +++ b/docs/src/concepts/streams.md @@ -0,0 +1 @@ +# streams — load from anywhere diff --git a/docs/src/contributing/contributing.md b/docs/src/contributing/contributing.md new file mode 100644 index 0000000..11554f5 --- /dev/null +++ b/docs/src/contributing/contributing.md @@ -0,0 +1 @@ +# contributing diff --git a/docs/src/contributing/stewardship.md b/docs/src/contributing/stewardship.md new file mode 100644 index 0000000..64f2b8e --- /dev/null +++ b/docs/src/contributing/stewardship.md @@ -0,0 +1 @@ +# format stewardship diff --git a/docs/src/formats/png.md b/docs/src/formats/png.md new file mode 100644 index 0000000..0810a47 --- /dev/null +++ b/docs/src/formats/png.md @@ -0,0 +1 @@ +# png diff --git a/docs/src/getting-started/building.md b/docs/src/getting-started/building.md new file mode 100644 index 0000000..0f5ca40 --- /dev/null +++ b/docs/src/getting-started/building.md @@ -0,0 +1 @@ +# building tinyff diff --git a/docs/src/getting-started/first-image.md b/docs/src/getting-started/first-image.md new file mode 100644 index 0000000..7c5702e --- /dev/null +++ b/docs/src/getting-started/first-image.md @@ -0,0 +1 @@ +# your first image diff --git a/docs/src/introduction.md b/docs/src/introduction.md new file mode 100644 index 0000000..075b44c --- /dev/null +++ b/docs/src/introduction.md @@ -0,0 +1,36 @@ +# welcome to tinyff + +tinyff is a small, embeddable C library for reading and writing sensory file +formats — images, audio, 3D, fonts, and more. + +--- + +## why tinyff? + +over here are tinyff inc, we hate the selfishness that gets shipped along with all these other multimedia libraries. they always assume the prescense of an allocator and a file which contains the media. so to help out with people need more accessibility for embedded and unsupported systems, tinyff stands by it [bring your own allocator](concepts/allocators.md) and [custom streams](concepts/streams.md) to make tinyff be the last multimedia library you will ever have to use. + +--- + +## what can i do with it? + +not much yet since tinyff has just started (and right now is a perfect time for you to consider becoming a contributer), check out the [github](https://github.com/tazyfoundsoup/tinyff). + +--- + +## where do i start? + +> hey there, just letting you know tinyff is still nonproduction level so lots of things will still be a bit messy. maybe consider being a contributer + +if you're new — head to [building tinyff](getting-started/building.md) and +get it compiling. then [load your first image](getting-started/first-image.md). + +if you want to understand the design — [the context](concepts/context.md) is +the best place to start. + +if you want to contribute — read about [format stewardship](contributing/stewardship.md). +own a format. ship something real. put it on your CV. + +--- + +tinyff is open source, actively developed, and looking for format stewards. +if you build something with it, we'd love to know.
\ No newline at end of file |