ソースを参照

Started documentation

Eiyeron Fulmincendii 9 年 前
コミット
3773f1ad40
共有3 個のファイルを変更した45 個の追加0 個の削除を含む
  1. 33 0
      doc/source/n2DLib/index.rst
  2. 12 0
      doc/source/n2DLib/introduction.rst
  3. 0 0
      doc/source/n2DLib/n2dlib.rst

+ 33 - 0
doc/source/n2DLib/index.rst

@@ -0,0 +1,33 @@
+.. _stdlib:
+
+###########################
+  Squirrel N2DLib Library 
+###########################
+
+Copyrigth (c) 2016 Florian "Eiyeron" Dormont
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+.. toctree::
+   :maxdepth: 1
+   :numbered:
+
+   introduction.rst
+   n2dlib.rst

+ 12 - 0
doc/source/n2DLib/introduction.rst

@@ -0,0 +1,12 @@
+.. _n2dLib_introduction:
+
+============
+Introduction
+============
+
+The n2DLib library consist in a set of functions inmplemented in C. They allow a TI-Nspire
+developper access the screen and the keybaord and offers functions to allow interacting
+with them.
+
+Thus, n2Dlib offers various functions from drawing a pixel, a sprite or circles to open
+a bitmap file to parse it and detect which key has been pressed.

+ 0 - 0
doc/source/n2DLib/n2dlib.rst