Browse Source

Add 'CARDPUTER CircuitPython/projects/README.md'

cube 9 months ago
parent
commit
fc2757aa47
1 changed files with 19 additions and 0 deletions
  1. 19
    0
      CARDPUTER CircuitPython/projects/README.md

+ 19
- 0
CARDPUTER CircuitPython/projects/README.md View File

@@ -0,0 +1,19 @@
1
+# Projects
2
+These projects should all run on the Cardputer in CircuitPython. Extra libraries may be needed from the CircuitPython library bundle - import errors will tell you what you need :P
3
+
4
+When using a file in CircuitPython, it needs to be renamed to "code.py" as this is what cPy will look for when running. 
5
+
6
+## Text Editor
7
+A mostly functional, but incredibly basic text editor.
8
+### Features
9
+- Cursor-less text editing (remember how Minecraft book writing used to feel like? Yeah. That.)
10
+- Save file - You have to type in the filename and extension yourself. The good news is the "." key works on this screen.
11
+- Open file - You can select from a list of files in the SD card. Still no line scrolling here, so only the first 7 files will be visible
12
+- If you open a file, the save menu conveniently fills in the filename for you, so you don't have to write it again to re-save.
13
+### Dependencies
14
+- Keyboard library from this repository
15
+- adafruit_display_text from the bundle
16
+### Issues
17
+- No line scrolling. Once you exceed 7 lines, you're guessing, bud
18
+- No folder support. Selecting folders in the SD card folder will break it.
19
+- There are no confirmation or warning messages. Use with caution and be sure that you aren't using a repeat filename, or it will overwrite the file without warning.