Commit fad3bdf3 authored by Vivien Kraus's avatar Vivien Kraus
Browse files

Update TODOs

parent 91bb30dd
Pipeline #27447 failed with stage
in 53 seconds
......@@ -17,6 +17,11 @@ _________________
4 Let me know
5 FAQ
.. 5.1 Emacs? Are you serious?
6 TODO s [0/3]
.. 6.1 TODO Continue implementing the game features
.. 6.2 TODO Restore imputation
.. 6.3 TODO Document the C++ binding
.. 6.4 TODO Fix the ASAN detection
......@@ -98,3 +103,39 @@ http://gugurumbe.frama.io/tarot/share/doc/tarot/tarot.html/index.html
| checking where .elc files should go... ${datadir}/emacs/site-lisp
| checking if org-mode is installed... yes
`----
6 TODO s [0/3]
==============
6.1 TODO Continue implementing the game features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The imputation is for step 6.2.
6.2 TODO Restore imputation
~~~~~~~~~~~~~~~~~~~~~~~~~~~
The imputation should be in an auxiliary module, and should be updated
independently of the game.
6.3 TODO Document the C++ binding
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There is a thin C++ binding to do memory management and to return
vectors. It is not documented though, however the parameters are
usually the same.
6.4 TODO Fix the ASAN detection
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For now, the detection of ASAN only works for c, which means dirty
stuff here: [in Makefile.am], [in ax_asan.m4]
[in Makefile.am] file:src/Makefile.am::These should be ASAN_CXXFLAGS
[in ax_asan.m4] file:m4/ax_asan.m4::Repeat the check for C++
......@@ -2,18 +2,26 @@
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgc534505">1. Read me</a></li>
<li><a href="#org7cf2570">2. Download</a></li>
<li><a href="#orga50e41a">3. Compile this project</a>
<li><a href="#org0ce03b0">1. Read me</a></li>
<li><a href="#orgb2df698">2. Download</a></li>
<li><a href="#org238f55b">3. Compile this project</a>
<ul>
<li><a href="#orgf544fb1">3.1. Gitlab users: make a source distribution</a></li>
<li><a href="#org28e0112">3.2. Everyone: configure, make and install</a></li>
<li><a href="#orgc4ad9ea">3.1. Gitlab users: make a source distribution</a></li>
<li><a href="#org38865e5">3.2. Everyone: configure, make and install</a></li>
</ul>
</li>
<li><a href="#orgb20bc83">4. Let me know</a></li>
<li><a href="#org2c1d00b">5. FAQ</a>
<li><a href="#org21c925d">4. Let me know</a></li>
<li><a href="#orgef82b1f">5. FAQ</a>
<ul>
<li><a href="#org6a89855">5.1. Emacs? Are you serious?</a></li>
<li><a href="#orgb794661">5.1. Emacs? Are you serious?</a></li>
</ul>
</li>
<li><a href="#orgda930c5">6. <span class="todo TODO">TODO</span> s <code>[0/3]</code></a>
<ul>
<li><a href="#orgd6e8da9">6.1. <span class="todo TODO">TODO</span> Continue implementing the game features</a></li>
<li><a href="#org21bd23c">6.2. <span class="todo TODO">TODO</span> Restore imputation</a></li>
<li><a href="#org460f741">6.3. <span class="todo TODO">TODO</span> Document the C++ binding</a></li>
<li><a href="#orge16ae4f">6.4. <span class="todo TODO">TODO</span> Fix the ASAN detection</a></li>
</ul>
</li>
</ul>
......@@ -21,7 +29,7 @@
</div>
<a id="orgc534505"></a>
<a id="org0ce03b0"></a>
# Read me
......@@ -30,14 +38,14 @@ Of Tarot*. It aims at providing a game and an artificial
intelligence.
<a id="org7cf2570"></a>
<a id="orgb2df698"></a>
# Download
The [manual](http://gugurumbe.frama.io/tarot/share/doc/tarot/tarot.html/index.html) is available online, and the latest [build](http://gugurumbe.frama.io/tarot/tarot-devel.tar.gz) too.
<a id="orga50e41a"></a>
<a id="org238f55b"></a>
# Compile this project
......@@ -49,7 +57,7 @@ some more work. Note that a source distribution is already available
my autotools!).
<a id="orgf544fb1"></a>
<a id="orgc4ad9ea"></a>
## Gitlab users: make a source distribution
......@@ -62,7 +70,7 @@ at the top-level directory that will:
- install a pre-commit hook into the git repository.
<a id="org28e0112"></a>
<a id="org38865e5"></a>
## Everyone: configure, make and install
......@@ -74,7 +82,7 @@ to know what options are available. If you want more details, see
`INSTALL`.
<a id="orgb20bc83"></a>
<a id="org21c925d"></a>
# Let me know
......@@ -82,12 +90,12 @@ I develop Tarot as a personal hobby. If you find it interesting, or
have bugs to submit, please let me know: `vivien@planete-kraus.eu`
<a id="org2c1d00b"></a>
<a id="orgef82b1f"></a>
# FAQ
<a id="org6a89855"></a>
<a id="orgb794661"></a>
## Emacs? Are you serious?
......@@ -98,3 +106,40 @@ you have to have emacs installed.
checking where .elc files should go... ${datadir}/emacs/site-lisp
checking if org-mode is installed... yes
<a id="orgda930c5"></a>
# s <code>[0/3]</code>
<a id="orgd6e8da9"></a>
## Continue implementing the game features
The imputation is for step [6.2](#org21bd23c).
<a id="org21bd23c"></a>
## Restore imputation
The imputation should be in an auxiliary module, and should be updated
independently of the game.
<a id="org460f741"></a>
## Document the C++ binding
There is a thin C++ binding to do memory management and to return
vectors. It is not documented though, however the parameters are
usually the same.
<a id="orge16ae4f"></a>
## Fix the ASAN detection
For now, the detection of ASAN only works for c, which means dirty
stuff here: [in Makefile.am](src/Makefile.am), [in ax<sub>asan.m4</sub>](m4/ax_asan.m4)
......@@ -48,3 +48,16 @@ you have to have emacs installed.
checking where .elc files should go... ${datadir}/emacs/site-lisp
checking if org-mode is installed... yes
#+END_EXAMPLE
* TODOs [0/3]
** TODO Continue implementing the game features
The imputation is for step [[Restore imputation]].
** TODO Restore imputation
The imputation should be in an auxiliary module, and should be updated
independently of the game.
** TODO Document the C++ binding
There is a thin C++ binding to do memory management and to return
vectors. It is not documented though, however the parameters are
usually the same.
** TODO Fix the ASAN detection
For now, the detection of ASAN only works for c, which means dirty
stuff here: [[file:src/Makefile.am::These should be ASAN_CXXFLAGS][in Makefile.am]], [[file:m4/ax_asan.m4::Repeat the check for C++][in ax_asan.m4]]
......@@ -22,6 +22,7 @@ AC_DEFUN([AX_ASAN], [
AC_MSG_RESULT([-fsanitize=address with -lasan])
])
AC_LANG_POP([C])
dnl Repeat the check for C++
CFLAGS="$NORMAL_CFLAGS"
LIBS="$NORMAL_LIBS"
])
......
......@@ -67,7 +67,8 @@ check_deal_LDADD = libtarot.la
check_deal_LIBS = $(ASAN_LIBS)
check_deal_cpp_SOURCES = check_deal.cpp
check_deal_cpp_CXXFLAGS = $(ASAN_CFLAGS) # Bof bof
# These should be ASAN_CXXFLAGS
check_deal_cpp_CXXFLAGS = $(ASAN_CFLAGS)
check_deal_cpp_LDADD = libtarot.la
check_deal_cpp_LIBS = $(ASAN_LIBS)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment