]> code.bitgloo.com Git - clyne/calculator.git/commitdiff
Update README.md master
authorclyne <tullivan99@gmail.com>
Sun, 29 Apr 2018 19:55:55 +0000 (15:55 -0400)
committerGitHub <noreply@github.com>
Sun, 29 Apr 2018 19:55:55 +0000 (15:55 -0400)
README.md

index 60b714dd71f1d642203d5a4098713b492ea7fa08..4d5cd17e8e7409b1d1e03ee81ccae24b3ae07f12 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,22 +1,18 @@
 # calculator
 A from-scratch operating system for a graphing calculator.  
   
-The goal of this project is to design a functional operating system for a
-graphing calculator based on the STM32L476RG processor. This OS has been
-designed from scratch to optimize for speed and code size, targeting the
-features necessary for a graphing calculator application.  
+The goal of this project is to design a functional operating system for a graphing calculator, currently based on the STM32L476RG processor. This OS is designed from scratch to optimize for speed and code size, targeting the features necessary for a graphing calculator application.  
   
 Required packages:
 * arm-none-eabi toolchain
 * openocd
 * make
   
-Use ```run.sh``` to upload the final output to the processor.  
+Use ```make``` to build the OS, which produces an ```out/main.elf```. Use ```run.sh``` to launch openocd and a gdb session to upload the OS to the device.  
   
   
 ## design overview
-The core of the operating system is written entirely in C and assembly. This
-project is paired with the [interpreter project](https://code.bitgloo.com/clyne/interpreter)
-(licensed under the GPL),
-which parses script from C strings. The operating system exposes calls to the
-script parser, and then loads the text file at ```initrd/init```. 
+  
+Soon: a link to my website with info on the actual device, and its hardware layout.  
+  
+The core of the operating system is written entirely in C and assembly. This project is paired with the [interpreter project](https://code.bitgloo.com/clyne/interpreter) (licensed under the GPL), a simple low-memory scripting language. Apart from other core functions, the operating system's goal is to expose calls to the interpreter, and then load the ```init``` script from the calculator.