Skip to content

Commit

Permalink
Getting started with The Unicorn Pixel Art Editor
Browse files Browse the repository at this point in the history
Some updates to the Index page, fixed broken links in the docs as well
  • Loading branch information
fotosyn committed Oct 10, 2023
1 parent f26bd3a commit 863d0b0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

Unicorn Pixel Art Editor is a tool for generating and exporting pixel art maps and palettes for [Pimoroni Unicorn LED panels](https://shop.pimoroni.com/products/space-unicorns).

You have two options for using the editor: [self-hosting / running locally](#self-host-locally) or using the [online version](https://github_username.github.io/unicorn-pixel-art-editor) hosted on GitHub Pages.
You have two options for using the editor: [self-hosting / running locally](#self-host-locally) or using the [online version](https://fotosyn.github.io/UnicornPixelEditor/) hosted on GitHub Pages.

There is also some guidance on running the required Python scripts on the Pimoroni Unicorn LED panels so you can see your artwork in all their LED lit-up glory!

Use our online version: You can begin creating pixel art immediately by selecting colors from the palette and interacting with the canvas.

#### Getting started:
[How to use the editor](#using-the-editor) / [Use the online version on GitHub Pages](https://github_username.github.io/unicorn-pixel-art-editor)
[How to use the editor](#using-the-editor) / [Use the online version on GitHub Pages](https://fotosyn.github.io/UnicornPixelEditor/)

#### Installing the app:
[Self-hosted installation steps](#self-host-locally) / [Using Thonny and Raspberry Pi Pico](#using-thonny-and-raspberry-pi-pico)
Expand All @@ -27,7 +27,7 @@ Use our online version: You can begin creating pixel art immediately by selectin
- **Palette:** Customize the color palette by editing the list of hex color codes.
- **Tools:** Use the provided tools to draw, shift pixels, and create pixel art on the canvas.

Now you're ready to start creating pixel art using the Unicorn Pixel Art Editor. Whether you choose to run it locally or use the [online version](https://github_username.github.io/unicorn-pixel-art-editor), have fun, get creative, and enjoy your pixel artwork in their LED-tastic glory!
Now you're ready to start creating pixel art using the Unicorn Pixel Art Editor. Whether you choose to run it locally or use the [online version](https://fotosyn.github.io/UnicornPixelEditor/), have fun, get creative, and enjoy your pixel artwork in their LED-tastic glory!

[Back to top](#top)

Expand Down Expand Up @@ -100,13 +100,12 @@ To see your pixel art creations come to life on the Pimoroni Unicorn LED panels

## Useful Resources <a name="useful-resources"></a> <!-- Added section -->

Here are some additional resources to help you get started with pixel art creation and using Thonny with the Raspberry Pi Pico:
Here are some additional resources to help you get started with pixel art creation and using Thonny with the onboard Raspberry Pi Pico:

- [Pimoroni Unicorn HAT Mini Guide](https://learn.pimoroni.com/tutorial/sandyj/getting-started-with-unicorn-hat-mini)
- [Pimoroni Unicorn HAT Mini Python Library](https://github.com/pimoroni/unicorn-hat-mini-python)
- [Pimoroni Unicorn LED Matrix Guides](https://shop.pimoroni.com/products/space-unicorns?variant=40842632953939)
- [Pimoroni MicroPython Libraries](https://github.com/pimoroni/pimoroni-pico/releases)
- [Thonny IDE Documentation](https://docs.thonny.org/en/latest/index.html)
- [Raspberry Pi Pico Getting Started](https://www.raspberrypi.org/documentation/pico/getting-started/)
- [Getting Started with MicroPython on Raspberry Pi Pico](https://learn.adafruit.com/getting-started-with-raspberry-pi-pico-circuitpython)
- [Getting started with Raspberry Pi Pico](https://projects.raspberrypi.org/en/projects/getting-started-with-the-pico)

These resources provide valuable information and tutorials on pixel art, Python programming, and using hardware like the Raspberry Pi Pico. They will enhance your experience with the Unicorn Pixel Art Editor.

Expand Down
2 changes: 2 additions & 0 deletions image-analyser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

The Unicorn Image Analyser is a web-based tool that allows you to load an image to generate a pixel map and palette for use with Unicorn pixel-art Python files. This documentation provides an overview of how to use the app and its features.

You can download and run this locally, or use the [online demo](https://fotosyn.github.io/UnicornPixelEditor/image-analyser/) here

## Getting Started

To get started with the Unicorn Image Analyser, follow these steps:
Expand Down
9 changes: 8 additions & 1 deletion index.htm
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
<div class="container">
<h1 id="app-header" class="mt-4">Unicorn Pixel Art Editor</h1>

<div class="mt-4">
<p>Unicorn Pixel Art Editor is a tool for generating and exporting pixel art maps and palettes for <a href="https://shop.pimoroni.com/products/space-unicorns">Pimoroni Unicorn LED panels</a>.</p>
<p>Visit the <a href="https://github.com/fotosyn/UnicornPixelEditor">Github pages</a> to get started / Convert existing images using the <a href="https://fotosyn.github.io/UnicornPixelEditor/image-analyser">image analyser</a>.</p>
</div>

<div id="grid-size-select-container" class="controls mt-4">
<label for="grid-size-select">Grid Size:</label>
<select id="grid-size-select" class="form-control"></select>
Expand Down Expand Up @@ -40,7 +45,7 @@ <h1 id="app-header" class="mt-4">Unicorn Pixel Art Editor</h1>

<div id="export-functions-container" class="mt-5">
<button id="export-button" class="export-button btn btn-success" onclick="exportGrid()">Generate code</button>
<button id="select-all-button" class="btn btn-secondary hidden" onclick="selectAllText()">Select All</button>
<button id="select-all-button" class="btn btn-secondary" onclick="selectAllText()">Select All</button>
<button id="copy-clipboard-button" class="btn btn-secondary" onclick="copyToClipboard()">Copy to Clipboard</button>
</div>

Expand All @@ -51,6 +56,8 @@ <h1 id="app-header" class="mt-4">Unicorn Pixel Art Editor</h1>
<div id="export-output-container" class="code-container mt-4">
<pre id="export-text-box" class="export-text-box"></pre>
</div>

<p class="mt-4">Version 1.0</p>
</div>

<!-- Additional imports -->
Expand Down

0 comments on commit 863d0b0

Please sign in to comment.