Skip to content

Commit

Permalink
Wikilinkfix (#104)
Browse files Browse the repository at this point in the history
* Update HydraMenu.md

* Update Playing-Sound.md

* Update userinput.md

* Update README.md
  • Loading branch information
echo-lalia authored Aug 24, 2024
1 parent c94ff4d commit f4f5ea1
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</p>


# Cardputer-MicroHydra
# MicroHydra
MicroHydra is a simple MicroPython based app launcher with some OS-like features.

<p align="center">
Expand Down
4 changes: 2 additions & 2 deletions wiki/HydraMenu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[HydraMenu.py](https://github.com/echo-lalia/Cardputer-MicroHydra/blob/wikiimprovements/src/lib/hydra/menu.py) is a module contributed by [Gabriel-F-Sousa](https://github.com/echo-lalia/Cardputer-MicroHydra/commits?author=Gabriel-F-Sousa), which is designed to make it easy to create menu screens for MicroHydra apps.
[HydraMenu.py](https://github.com/echo-lalia/Cardputer-MicroHydra/blob/main/src/lib/hydra/menu.py) is a module contributed by [Gabriel-F-Sousa](https://github.com/echo-lalia/Cardputer-MicroHydra/commits?author=Gabriel-F-Sousa), which is designed to make it easy to create menu screens for MicroHydra apps.

HydraMenu is being utilized heavily by the (newly refurbished) inbuilt [settings app](https://github.com/echo-lalia/Cardputer-MicroHydra/blob/wikiimprovements/src/launcher/settings.py). Please take a look at that file for some practical examples of what can be done with the module.
HydraMenu is being utilized heavily by the (newly refurbished) inbuilt [settings app](https://github.com/echo-lalia/Cardputer-MicroHydra/blob/main/src/launcher/settings.py). Please take a look at that file for some practical examples of what can be done with the module.

Here's a simplified example, for your reference:
``` Python
Expand Down
4 changes: 2 additions & 2 deletions wiki/Playing-Sound.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ There are two main modules built-in to MicroHydra currently, which can be used f
<br />

### lib.audio.Audio
MicroHydra's [audio](https://github.com/echo-lalia/Cardputer-MicroHydra/tree/wikiimprovements/src/lib/audio) module subclasses the apropriate audio module for the current device (Currently this is only `i2ssound`, but may be expanded in the future), and initializes it with the apropriate values for the device.
MicroHydra's [audio](https://github.com/echo-lalia/Cardputer-MicroHydra/tree/main/src/lib/audio) module subclasses the apropriate audio module for the current device (Currently this is only `i2ssound`, but may be expanded in the future), and initializes it with the apropriate values for the device.

Note:
> *`i2ssound` was previously named `M5Sound`, and was contributed by [Lana-chan](https://github.com/echo-lalia/Cardputer-MicroHydra/commits?author=Lana-chan), for playing high-quality sound on the Cardputer.
Expand Down Expand Up @@ -59,7 +59,7 @@ i2ssound.Sample(source, buffer_size=1024)
<br /><br /><br />

### beeper
[beeper.py](https://github.com/echo-lalia/Cardputer-MicroHydra/blob/wikiimprovements/src/lib/hydra/beeper.py) is a module for playing simple UI beeps.
[beeper.py](https://github.com/echo-lalia/Cardputer-MicroHydra/blob/main/src/lib/hydra/beeper.py) is a module for playing simple UI beeps.

This module is very imperfect. It is somewhat limited in its use, however, it *is* simple to use.
> In previous versions, this module used its own, blocking, implementation for sending audio to the speaker. However, the current version is just a wrapper for the `Audio` class above. The audio is now much higher quality and more consistent, however there is a noticable delay in it. I would like to fix this in the future, but I'm not sure how to do that.
Expand Down
2 changes: 1 addition & 1 deletion wiki/userinput.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

### lib.userinput.UserInput

[userinput](https://github.com/echo-lalia/Cardputer-MicroHydra/blob/wikiimprovements/src/lib/userinput/userinput.py) provides a all of a devices physical inputs in one place.
[userinput](https://github.com/echo-lalia/Cardputer-MicroHydra/blob/main/src/lib/userinput/userinput.py) provides a all of a devices physical inputs in one place.

At its core, the module is based on the device-specific `_keys` module, which provides logic for reading the keypresses and converting them into readable strings. The `UserInput` class subclasses the `_keys.Keys` class, and inherits those device-specific features.
`UserInput` can also provide other kinds of input, such as providing touch data from a device with a touchscreen. These extra features, of course, are based on the specific device being used.
Expand Down

0 comments on commit f4f5ea1

Please sign in to comment.