Ver Fonte

Update README.md

Karl Zylinski há 2 meses atrás
pai
commit
370b2d1ef8
1 ficheiros alterados com 4 adições e 0 exclusões
  1. 4 0
      README.md

+ 4 - 0
README.md

@@ -6,6 +6,8 @@ Karl2D is a library for creating 2D games using the Odin programming language. T
 
 Discuss and get help in the #karl2d channel [on my Discord server](https://discord.gg/4FsHgtBmFK).
 
+See [karl2d.doc.odin](https://github.com/karl-zylinski/karl2d/blob/master/karl2d.doc.odin) for an API overview.
+
 Here's a minimal "Hello world" program:
 
 ```odin
@@ -63,6 +65,8 @@ Here are some things I want to get feedback on:
   way, so we can use them both on desktop and on web. This sometimes made them a bit more chatty.
   For example, I had to move some variables to the global scope. Should I approach this differently?
 
+- Is it annoying that the documentation file `karl2d.doc.odin` has a real `.odin` file extension? I like that it gets syntax highlight for everyone etc. But it can also be a bit disruptive it "go to symbol" etc. Perhaps I should chance it to `.odin_doc` or something.
+
 Join my Discord server and let me know in the #karl2d channel what you think! Here's the invite: https://discord.gg/4FsHgtBmFK
 
 ## Is this a Raylib clone?