README.md

@@ -1,9 +1,3 @@
-**This library is very old and unmaintained.**
-
-There may be some good bits worth salvaging, but for new projects I recommend the [avr-c-boilerplate](https://github.com/MightyPork/avr-c-boilerplate) as a base instead. Copy and port good modules from this library if you like.
-
----
-
 # "porklib", MightyPork's Arduino Library
 
 This library aims to make development for AVR in C easy and fun.
@@ -18,12 +12,12 @@ Pull requests to add new modules are welcome, please go ahead!
 
 ## Makefile
 
-You can use the provided Makefile to build your project with this library.
+You can use the provided Makefile to boild your project with this library.
 
 A project typically consists of one `main.c` file, and some `*_config.c` files where the
 library headers request it (those define eg. IO pin mapping).
 
-Adjust the Makefile to your needs!
+Adjust the Makefile to yoru needs!
 
 ## License
 

examples/sipo_pwm_74HC4094/sipo_pwm_config.h

@@ -1,17 +1,10 @@
 /* Config for SIPO PWM */
 
-// --- PWM pin aliases ---
-
-// Store signal
+// PWM pin aliases
 #define SPWM_STR  D2
-// Shift/clock signal
 #define SPWM_CLK  D3
-// Data signal
 #define SPWM_DATA D4
 
-
-// --- Other settings ---
-
 // Number of PWM levels (color depth)
 #define SPWM_COLOR_DEPTH 256
 

lib/sipo_pwm.h

@@ -2,28 +2,23 @@
 
 // --- SIPO PWM Module ---
 //
-// SIPO = shift register with paralel output.
+// SIPO = Serial IN, Parallel OUT
 //
 // This module lets you use SIPO outputs as a "software PWM".
 //
-// Tested to work on 74hc4094 and 74hc595
+// Tested on 74HC4094,
+// should also work on 74HC595 (may need some small changes)
 
 #include <stdint.h>
 
 // Your file with configs
 #include "sipo_pwm_config.h"
 /*
-	// --- PWM pin aliases ---
-	
-	// Store signal
+	// PWM pin aliases
 	#define SPWM_STR  D2
-	// Shift/clock signal
 	#define SPWM_CLK  D3
-	// Data signal
 	#define SPWM_DATA D4
 
-	// --- Other settings ---
-	
 	// Number of PWM levels (color depth)
 	#define SPWM_COLOR_DEPTH 256
 
@@ -43,7 +38,7 @@ extern uint8_t spwm_levels[SPWM_CHANNELS];
 void spwm_init();
 
 
-/** Perform one PWM cycle.
- * This should be called in a Timer ISR or a loop.
+/** Display PWM channels.
+ * This could be called in a Timer ISR.
  */
 void spwm_send();