commit d3753f8
0uppy
·
2026-09-09 18:35:39 +0000 UTC
parent c9e2acd
misc - updated the current markdown file for the project to be up-to-date with the new cotton :P
1 files changed,
+12,
-14
+12,
-14
1@@ -2,11 +2,13 @@
2
3 
4
5-cotton is a tiny virtual computer that lives in your windows - it was written in C99 and has 64 KiB of memory and runs programs written in the cot programming language.
6+cotton is a small stack machine for the cot programming language (a concatenative language inspired by Lua*, Forth and Uxntal) written in C99 .
7
8-cotton was originally based on a CHIP-8 emulator, but has since evolved into its own thing somewhat inspired by [uxn](https://100r.co/site/uxn.html) (check it out!! its an amazing project!!) and the concept of a small, easy-to-understand virtual computer.
9+cotton originally started as a slightly modified CHIP8 emulator, then was repurposed into being a fantasy computer inspired by [uxn](https://100r.co/site/uxn.html) but has ultimately ended up turning into what you're seeing right now :) - the old version of the project can be found on the 'old-cotton' branch of this repo, and, as you may be able to guess, its effectively dead and wont get updated anymore, being there purely for archival purposes xP
10
11-cotton is a passion pet project and while i do get alot of suggestions via my friends, i am the only and main developer of it, so, don't expect anything grandiouse or of perfect quality, at the end of theday this is all a big learning project that im taking at my own pace!! xP
12+cotton is a passion hobby project being made solely by me, so, dont expect anything grandiose or of high quality - even then, suggestions and ideas are always welcome!! :D
13+
14+(*Inspired by Lua's internal engine's layout, not really the syntax itself)
15
16 ## building cotton,
17
18@@ -15,8 +17,6 @@ meson setup build
19 ninja -C build
20 ```
21
22-(make sure you also have sdl installed or else windows wont open wawawaw!!)
23-
24 ## running cotton,
25
26 ```
27@@ -25,20 +25,18 @@ cotton <file.cot>
28
29 ## docs
30
31-before v0.2, i used to have everything about the cot programming language and cotton's tooling on this md file, but, as i have now made docs for cotton and it's ecosystem, i strongly suggest that anyone who wants to read the docs gets [mandoc](https://mandoc.bsd.lv/) (should be called packaged as mandoc on your distro of choice, probably :P) to do so!!
32+current docs are a bit outdated, will work on them soon enough
33
34 ## cotton's mascot
35
36 
37
38-this is cotton's mascot!! his name is ton!! he was drawn by me using cotton's colour palette!! say hi to ton!! :3
39-
40-## credits
41-
42-i'd like to thank [this guide](https://austinmorlan.com/posts/chip8_emulator/) for helping me figure out the initial base for cotton, even if 90% of it is gone by now, it helped me learn alot of stuff that i am now applying for cotton, awesome stuff ^^
43+this is cotton's mascot!! his name is ton!! he was drawn by me using old cotton's own colour palette!! say hi to ton!! :3
44
45-i'd also like to thank [chld](https://srcdump.net/chld/) for making a C port of eikimaker.go AND currently working on a haiku backend for cotton - both arent merged to the repo yet but im still very grateful for both :)
46+## to-do list for (cot)ton
47
48-i'd like to thank [emilia](https://srcdump.net/emilia9/) for the patches to add *BSD support and fix the compiler warning for the comments :D
49+honestly i dont have alot to write here for the time being, mostly because im afraid to set high expectations that i can't achieve, however:
50
51-and also [pita](https://pita.im/), [lotte](https://srcdump.net/lotte/), [merc](https://merc.4plt.ch/) and [shrub](https://shrub.industries/) (in no particular order) for all of the cool suggestions and guidance for cotton as of the release of v0.2, thank you so much!! :D
52+* Repurpose the current code into my new idea for the project and run something []
53+* Update the current docs []
54+* One day figure out how to optionally compile cot files into uxntal files (might be too ambitious but one can dream, right :<) []