Skip to content

Commit

Permalink
Update Juego readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgedevs committed Dec 5, 2023
1 parent 661b27a commit ac239cb
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 15 deletions.
Binary file modified Design/banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Design/juego-samples.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Design/juego-store.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,17 @@

Open-source, Meadow-powered, multigame handheld console with DPads, speakers and a colored display.

#### Are you brand new to Meadow?

If you've never deployed a Meadow app before, you'll want to check out the [Getting Started Guide](https://developer.wildernesslabs.co/Meadow/Getting_Started/) which will get your development environment up and running and validate that you can build and deploy.

## Contents
* [Purchasing or Building](#purchasing-or-building)
* [Getting Started](#getting-started)
* [Hardware Specifications](#hardware-specifications)
* [Building Locally](#building-locally)
* [Additional Samples](#additional-samples)
* [Juego Hack Kit Version](#juego-hack-kit-version)
* [Support](#support)

## Purchasing or Building

Expand All @@ -24,7 +29,7 @@ Open-source, Meadow-powered, multigame handheld console with DPads, speakers and
</tr>
<tr>
<td>
You can get a Juego board from the <strong>Wilderness Labs store</strong> very soon.
You can get a Juego board from the <strong><a href="https://store.wildernesslabs.co/collections/frontpage/products/juego">Wilderness Labs store</a></strong>.
</td>
<td>
You can also build a simpler Juego using a monocolor display and push buttons.
Expand All @@ -34,7 +39,7 @@ Open-source, Meadow-powered, multigame handheld console with DPads, speakers and

## Getting Started

To make using the hardware even simpler, we've created a Nuget package that instantiates and encapsulates the onboard hardware into a `Juego` class.
To make using the hardware even simpler, we've created a [NuGet package](https://www.nuget.org/packages/Meadow.Juego) that instantiates and encapsulates the onboard hardware into a `Juego` class.

1. Add the ProjectLab Nuget package your project:
- `dotnet add package Meadow.Juego`, or
Expand Down Expand Up @@ -131,19 +136,14 @@ public class MeadowApp : App<F7CoreComputeV2>

You can find the schematics and other design files in the [Hardware folder](Source/Hardware).

## Building locally

When using the develop branch, you'll need to clone additional Meadow repos:
## Additional Samples

- [Meadow.Core](https://github.com/WildernessLabs/Meadow.Core)
- [Meadow.Units](https://github.com/WildernessLabs/Meadow.Units)
- [Meadow.Contracts](https://github.com/WildernessLabs/Meadow.Contracts)
- [Meadow.Foundation](https://github.com/WildernessLabs/Meadow.Foundation)
- [Meadow.Logging](https://github.com/WildernessLabs/Meadow.Logging)
Be sure to clone all these repos including `Juego` at the same folder level and set all repos to the `develop` branch.

Also, make sure you are running the latest version of Meadow OS on your Juego v2 board.
1. **[Setup your Meadow Build Environment](http://developer.wildernesslabs.co/Meadow/Getting_Started/Deploying_Meadow/)** - If you haven't deployed a Meadow app before, you'll need to setup your IDE extension(s), deploy Meadow.OS, etc.
2. **[Run the Demo App](Source/Juego_Demo/)** - Deploy the Juego demonstration app to see the built in peripherals at work.
3. **[Check out the Juego.Samples repo](https://github.com/WildernessLabs/Juego.Samples)** - We recommend cloning the [Juego.Samples](https://github.com/WildernessLabs/Juego.Samples) repo. There you'll find a bunch of awesome samples that you can run right out-of-the box!
<a href="https://github.com/WildernessLabs/Juego.Samples">
<img src="Design/juego-samples.png" alt="juego, iot, project, samples" style="margin-top:10px;margin-bottom:10px" />
</a>

## Juego Hack Kit Version

Expand Down Expand Up @@ -180,3 +180,8 @@ Includes five games:
</tr>
</table>

## Support

Having trouble building/running these projects?
* File an [issue](https://github.com/WildernessLabs/Meadow.Desktop.Samples/issues) with a repro case to investigate, and/or
* Join our [public Slack](http://slackinvite.wildernesslabs.co/), where we have an awesome community helping, sharing and building amazing things using Meadow.

0 comments on commit ac239cb

Please sign in to comment.