diff --git a/README.md b/README.md index 970b605..b0b21ef 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ A pure Python 2D/3D graphics library that outputs to windows bitmap format * Developed and tested using Python 3.8 / 3.10.4 / 3.11 * No dependencies required + * ![API Reference](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/BitmapLib_Doc.md) # Instructions @@ -11,10 +12,12 @@ A pure Python 2D/3D graphics library that outputs to windows bitmap format Run Hello_somestring_here.py This will show minimum code to accomplish certain tasks -* ![Hello_Darkness.py](https://github.com/TechnoTanuki/Python_BMP/blob/main/Hello_Darkness.py) (my old friend) is a minimum template + +* ![Hello_Darkness.py](https://github.com/TechnoTanuki/Python_BMP/blob/main/Hello_Darkness.py) (my old friend) is a minimum template Run ![Features_Speedtest.py](https://github.com/TechnoTanuki/Python_BMP/blob/main/Features_Speedtest.py) -* It should generate a bitmap and open MS Paint under windows to show output... + +* It should generate a bitmap and open MS Paint under windows to show output... * Close the MS Paint window to execute another script # Unit tests (images are links to test) @@ -33,12 +36,12 @@ See: https://k0nze.dev/posts/python-relative-imports-vscode/ * (Module Relative imports dont work in VS Code but code as-is runs fine in terminal or IDLE) # Moar docs -* ![Hello Graphics](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/Hello_Graphics.md) -* ![Hello Text](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/Hello_Text.md) -* ![Hello Fractals](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/Hello_Fractals.md) -* ![Hello Image Processing](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/Hello_Image_Processing.md) +* ![Hello Graphics](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/Hello_Graphics.md)\ +* ![Hello Text](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/Hello_Text.md) +* ![Hello Fractals](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/Hello_Fractals.md) +* ![Hello Image Processing](https://github.com/TechnoTanuki/Python_BMP/blob/main/docs/Hello_Image_Processing.md)