diff --git a/README.dbk b/README.dbk new file mode 100644 index 0000000..75c3fbf --- /dev/null +++ b/README.dbk @@ -0,0 +1,121 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE article> +<article + xmlns="http://docbook.org/ns/docbook" version="5.0" + xmlns:xlink="http://www.w3.org/1999/xlink" > + <info> + <title>Go game</title> + </info> + <para> + Parametric goban and stones for blind players + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + One version for laser-cutting + </para> + </listitem> + <listitem> + <para> + One version for 3D printing + </para> + </listitem> + </itemizedlist> + <para> + You can choose your size (like 6x6, 9x9, 13x13 or 19x19). + </para> + <section xml:id="licence"> + <title>Licence</title> + <para> + This work is dual-licensed under MIT and EUPL-1.2. + </para> + <para> + Please use under the license you want. + </para> + <para> + Please contribute on official repository under both licences. + </para> + </section> + <section xml:id="laser-cutting-version"> + <title>Laser-cutting version</title> + <itemizedlist spacing="compact"> + <listitem> + <para> + Engrave then cut one base. + </para> + </listitem> + <listitem> + <para> + Engrave verso of upper sheet. + </para> + </listitem> + <listitem> + <para> + Engrave then cut recto of upper sheet. + </para> + </listitem> + <listitem> + <para> + Stick upper sheet on base. + </para> + </listitem> + </itemizedlist> + <para> + Hint + </para> + <para> + Create three goban, each in an other color. Reorder your stones to + have good colors for each set. + </para> + <para> + Use --help on generator script to personalize your goban. + </para> + </section> + <section xml:id="d-printing-version"> + <title>3D printing version</title> + <itemizedlist spacing="compact"> + <listitem> + <para> + Adjust params.scad to what you want, use params-small.scad or + params-large.scad as example. + </para> + </listitem> + <listitem> + <para> + Print your goban and your stones. + </para> + </listitem> + </itemizedlist> + <para> + You have two different models for black stones, one with ergot and + strips, the other with a demi-spherical. First is better for small + version and the other for large version. + </para> + </section> + <section xml:id="todo"> + <title>TODO</title> + <itemizedlist spacing="compact"> + <listitem> + <para> + A 3D printed 19x19 goban composed of smaller games. + </para> + </listitem> + <listitem> + <para> + A 3D printed version to use with real go stones and marbles. + </para> + </listitem> + <listitem> + <para> + A CNC based version to use with real go stones and marbles. + </para> + </listitem> + </itemizedlist> + <para> + Want to contribute ? It's open ! + </para> + <para> + Happy cutting/printing and good game ! + </para> + </section> +</article> diff --git a/README.rst b/README.rst deleted file mode 100644 index 1b1213f..0000000 --- a/README.rst +++ /dev/null @@ -1,56 +0,0 @@ -Go game -####### - -Parametric goban and stones for blind players - -- One version for laser-cutting -- One version for 3D printing - -You can choose your size (like 6x6, 9x9, 13x13 or 19x19). - -Licence -------- - -This work is dual-licensed under MIT and EUPL-1.2. - -Please use under the license you want. - -Please contribute on official repository under both licences. - -Laser-cutting version ---------------------- - -- Engrave then cut one base. -- Engrave verso of upper sheet. -- Engrave then cut recto of upper sheet. -- Stick upper sheet on base. - -.. hint:: - - Create three goban, each in an other color. - Reorder your stones to have good colors for each set. - -Use --help on generator script to personalize your goban. - -3D printing version -------------------- - -- Adjust params.scad to what you want, use params-small.scad - or params-large.scad as example. -- Print your goban and your stones. - -You have two different models for black stones, one with ergot -and strips, the other with a demi-spherical. First is better -for small version and the other for large version. - -TODO ----- - -- A 3D printed 19x19 goban composed of smaller games. -- A 3D printed version to use with real go stones and marbles. -- A CNC based version to use with real go stones and marbles. - - -Want to contribute ? It's open ! - -Happy cutting/printing and good game !