diff --git a/README.md b/README.md index 07c2d12..6c0e367 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ SPDX-License-Identifier: Apache-2.0 [![Coverage Status](https://coveralls.io/repos/github/a-maze-d/fledex/badge.svg?branch=main)](https://coveralls.io/github/a-maze-d/fledex?branch=main) [![Downloads](https://img.shields.io/hexpm/dt/fledex.svg)](https://hex.pm/packages/fledex) + Fledex is a small [Elixir](https://elixir-lang.org/) library It really is intended for educational purposes. It is written for a RaspberryPi Zero W running [Nerves](https://nerves-project.org/) especially with a [Nerves-Livebook](https://hexdocs.pm/nerves/getting-started.html#nerves-livebook). diff --git a/docs/fledex.cheatmd b/docs/fledex.cheatmd new file mode 100644 index 0000000..40b19ef --- /dev/null +++ b/docs/fledex.cheatmd @@ -0,0 +1,20 @@ + + +At this point this is just a collection of ideas on waht to writ in the cheat sheet. Once we have all the information we should format it in the correct way. + +# initialization +* use fledex + +# macros +* animation +* static +* effect +* component + +# utilities +* job +(* coordinator) \ No newline at end of file diff --git a/docs/fledex_logo.png.license b/docs/fledex_logo.png.license new file mode 100644 index 0000000..a18cf96 --- /dev/null +++ b/docs/fledex_logo.png.license @@ -0,0 +1,3 @@ +Copyright 2024, Matthias Reik + +SPDX-License-Identifier: Apache-2.0 diff --git a/docs/fledex_logo.svg.license b/docs/fledex_logo.svg.license new file mode 100644 index 0000000..a18cf96 --- /dev/null +++ b/docs/fledex_logo.svg.license @@ -0,0 +1,3 @@ +Copyright 2024, Matthias Reik + +SPDX-License-Identifier: Apache-2.0 diff --git a/mix.exs b/mix.exs index bfcc870..779a5ef 100644 --- a/mix.exs +++ b/mix.exs @@ -179,6 +179,7 @@ defmodule Fledex.MixProject do defp copy_doc_images(_) do images = [ + {"docs/fledex_logo.svg", "doc/fledex_logo.svg"}, {"docs/architecture.drawio.svg", "doc/architecture.drawio.svg"}, {"docs/hardware.drawio.svg", "doc/hardware.drawio.svg"}, {"docs/hardware-Page-2.drawio.svg", "doc/hardware-Page-2.drawio.svg"}