updates

w84death · Jul 28, 2023 · 5c55c9b · 5c55c9b
1 parent 8f61128
commit 5c55c9b
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -4,21 +4,21 @@
 smolOS is a tiny and simple operating system for MicroPython giving the user POSIX-like environment to play and research. It came with a set of tools and demos.
 System should run on any MicroPython supproted board but it's tested and developed for XIAO RP2040,
 
-## Latest documentation available at official homepage:
+### Latest documentation available at official homepage:
 - [smolOS homepage (http)](http://smol.p1x.in/os/)
 - [smolOS homepage (https)](https://smol.p1x.in/os/)
 
 ![smolOS XIAO](media/smolos.png)
 
-## Real Life Usecases
+### Real Life Usecases
 
 * listing and removing unwanted files on board
 * checking free space
 * quicly iterating parameters for a program
 * learning basics of disk operating system
 * having fun with microcontrollers
 
-## smolOS Features
+### smolOS Features
 
 * Changes microcontroller into a small working PC
 * Homemade for fun and learning
@@ -31,6 +31,22 @@ System should run on any MicroPython supproted board but it's tested and develop
 * Stability and simplicity are the main principle behind the code
 * Free and open :)
 
+### Additoinal Programs
+
+* ansi - Displays ANSI escape codes
+* life - Game of Life implementation for smolOS (text)
+* buzz - Simple synthezator for 1-bit music (requies a buzzer)
+
+All of those are for NeoPixel Grid 5x5 BFF:
+* duck - Yellow Rubber Duck for programmers
+* neolife - Game of Life implementation
+* pixel - Tools for playing with one LED
+* plasma - Demoscene plasma effect
+* font - Font bitmaps (for scroller)
+* scroller - Scrolls text
+
+
+
 ## Installation
 
 ### Super Quick Quide

diff --git a/ansi.py b/ansi.py
@@ -1,5 +1,5 @@
 """
-Template for user programs for smolOS
+Displays ANSI escape sequences
 
 (c)2023/07 Krzysztof Krystian Jankowski
 Homepage: https://smol.p1x.in/os/

diff --git a/font.py b/font.py
@@ -1,4 +1,9 @@
+"""
+Font for 5x5 NeoPixel display
 
+(c)2023/07 Krzysztof Krystian Jankowski
+Homepage: https://smol.p1x.in/os/
+"""
 GLYFS = {
 
     "0":"0xeccdc0",

diff --git a/pixel.py b/pixel.py
@@ -1,5 +1,5 @@
 """
-Pixel - tools for playing with one NeoPixel
+Tools for playing with one NeoPixel LED
 
 (c)2023/07 Krzysztof Krystian Jankowski
 Homepage: https://smol.p1x.in/os/

diff --git a/plasma.py b/plasma.py
@@ -1,4 +1,9 @@
-# Plasma effect for Adafruit NeoPixel BFF 5x5 LED Grid
+"""
+Demoscene plasma effect for Adafruit NeoPixel BFF 5x5 LED Grid
+
+(c)2023/07 Krzysztof Krystian Jankowski
+Homepage: https://smol.p1x.in/os/
+"""
 import machine
 import utime
 import _thread

diff --git a/scroller.py b/scroller.py
@@ -1,3 +1,9 @@
+"""
+Scrolls text over NeoPixel Grid BFF
+
+(c)2023/07 Krzysztof Krystian Jankowski
+Homepage: https://smol.p1x.in/os/
+"""
 import machine
 import utime
 import neopixel