Commit ae2acc9c authored by VIEVILLE Thierry's avatar VIEVILLE Thierry
Browse files

sync from makefile

parent 4f57afcb
Pipeline #299358 passed with stage
in 2 seconds
# esp32galileo
# esp32galileo
ESP32 firmware providing a REST API for controlling the galileo science outreach setup
## A ESP32 micro-controller to drive the galileo board experiment
......@@ -51,38 +51,60 @@ Tutorial video: [https://youtu.be/ew7ONP2M09M](https://youtu.be/ew7ONP2M09M)
## Installation
## Package repository
Download node at [nodejs.org](http://nodejs.org) and install it, if you haven't already.
- Package files: <a target="_blank" href="https://gitlab.inria.fr/line/aide-group/esp32galileo">https://gitlab.inria.fr/line/aide-group/esp32galileo</a>
```sh
npm install esp32galileo --save
```
- Package documentation: <a target="_blank" href="https://line.gitlabpages.inria.fr/aide-group/esp32galileo">https://line.gitlabpages.inria.fr/aide-group/esp32galileo</a>
## Usage
- Source files: <a target="_blank" href="https://gitlab.inria.fr/line/aide-group/esp32galileo/-/tree/master/src">https://gitlab.inria.fr/line/aide-group/esp32galileo/-/tree/master/src</a>
```
```
- Version: \`0.1.0\`
## Tests
- License: \`CECILL-C\`
## Installation
This is a [Node.js](https://nodejs.org/) module, installed using the [`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)command line tools.
```sh
npm install
npm test
npm install git+https://gitlab.inria.fr/line/aide-group/esp32galileo.git
```
## Usage
- Refer to <a target='_blank' href='https://gitlab.inria.fr/line/aide-group/esp32galileo/-/blob/master/src/usage_galileo.md'>usage_galileo</a>, for the Galileo mechanism web service usage.<br/>
### npm script usage
```
npm install : installs all package dependencies.
npm run build: builds the different doc and test files.
npm test : runs functional and non-regression tests.
npm clean : cleans installation files.
npm run sync : syncs the files with the git repository.
```
## Dependencies
- [esp32gpiocontrol](https://gitlab.inria.fr/line/aide-group/esp32gpiocontrol): ESP32 firmware providing a REST API for controlling the GPIO interface and higher functions
- <tt>esp32gpiocontrol</tt>: ESP32 firmware providing a REST API for controlling the GPIO interface and higher functions
## Dev Dependencies
- [aidebuild](https://gitlab.inria.fr/line/aide-group/aidebuild): Builds multi-language compilation packages and related documentation.
## Dev Dependencies
- `aidebuild`: Builds multi-language compilation packages and related documentation.
## License
## Author(s)
CECILL-C
- Éric Pascual
&nbsp; <big><a target="_blank" href="mailto:eric.g.pascual@gmail.com">&#128386;</a></big>
&nbsp; <big><a target="_blank" href="https://twitter.com/ericpobot">&#128463;</a></big>
- Martine Olivi
&nbsp; <big><a target="_blank" href="mailto:martine.olivi@inria.fr">&#128386;</a></big>
&nbsp; <big><a target="_blank" href="https://www-sop.inria.fr/members/Martine.Olivi/">&#128463;</a></big>
- Sabrina Barnabé
&nbsp; <big><a target="_blank" href="mailto:snjazur@gmail.com">&#128386;</a></big>
&nbsp; <big><a target="_blank" href="http://snjazur.fr">&#128463;</a></big>
- Thierry Viéville
&nbsp; <big><a target="_blank" href="mailto:thierry.vieville@inria.fr">&#128386;</a></big>
&nbsp; <big><a target="_blank" href="https://www-sop.inria.fr/members/Thierry.Vieville">&#128463;</a></big>
......@@ -113,27 +113,64 @@
<li>The <a href="https://gitlab.inria.fr/line/aide-group/esp32galileo/-/blob/master/src/hardware.md">electronic hardware description</a></li>
<li>The <a href="https://gitlab.inria.fr/line/aide-group/esp32galileo/-/blob/master/src/usage_galileo.md">webservice usage description</a></li>
</ul>
<h2>Package repository</h2>
<ul>
<li>
<p>Package files: <a target="_blank" href="https://gitlab.inria.fr/line/aide-group/esp32galileo">https://gitlab.inria.fr/line/aide-group/esp32galileo</a></p>
</li>
<li>
<p>Package documentation: <a target="_blank" href="https://line.gitlabpages.inria.fr/aide-group/esp32galileo">https://line.gitlabpages.inria.fr/aide-group/esp32galileo</a></p>
</li>
<li>
<p>Source files: <a target="_blank" href="https://gitlab.inria.fr/line/aide-group/esp32galileo/-/tree/master/src">https://gitlab.inria.fr/line/aide-group/esp32galileo/-/tree/master/src</a></p>
<ul>
<li>
<p>Version: `0.1.0`</p>
</li>
<li>
<p>License: `CECILL-C`</p>
</li>
</ul>
</li>
</ul>
<h2>Installation</h2>
<p>Download node at <a href="http://nodejs.org">nodejs.org</a> and install it, if you haven't already.</p>
<pre class="prettyprint source lang-sh"><code>npm install esp32galileo --save
<p>This is a <a href="https://nodejs.org/">Node.js</a> module, installed using the <a href="https://docs.npmjs.com/getting-started/installing-npm-packages-locally"><code>npm</code></a>command line tools.</p>
<pre class="prettyprint source lang-sh"><code>npm install git+https://gitlab.inria.fr/line/aide-group/esp32galileo.git
</code></pre>
<h2>Usage</h2>
<pre class="prettyprint source"><code>
</code></pre>
<h2>Tests</h2>
<pre class="prettyprint source lang-sh"><code>npm install
npm test
<ul>
<li>Refer to <a target='_blank' href='https://gitlab.inria.fr/line/aide-group/esp32galileo/-/blob/master/src/usage_galileo.md'>usage_galileo</a>, for the Galileo mechanism web service usage.<br/></li>
</ul>
<h3>npm script usage</h3>
<pre class="prettyprint source"><code>npm install : installs all package dependencies.
npm run build: builds the different doc and test files.
npm test : runs functional and non-regression tests.
npm clean : cleans installation files.
npm run sync : syncs the files with the git repository.
</code></pre>
<h2>Dependencies</h2>
<ul>
<li><a href="https://gitlab.inria.fr/line/aide-group/esp32gpiocontrol">esp32gpiocontrol</a>: ESP32 firmware providing a REST API for controlling the GPIO interface and higher functions</li>
<li><tt>esp32gpiocontrol</tt>: ESP32 firmware providing a REST API for controlling the GPIO interface and higher functions</li>
</ul>
<h2>Dev Dependencies</h2>
<ul>
<li><a href="https://gitlab.inria.fr/line/aide-group/aidebuild">aidebuild</a>: Builds multi-language compilation packages and related documentation.</li>
<li><code>aidebuild</code>: Builds multi-language compilation packages and related documentation.</li>
</ul>
<h2>License</h2>
<p>CECILL-C</p></article>
<h2>Author(s)</h2>
<ul>
<li>Éric Pascual
  <big><a target="_blank" href="mailto:eric.g.pascual@gmail.com">🖂</a></big>
  <big><a target="_blank" href="https://twitter.com/ericpobot">🗏</a></big></li>
<li>Martine Olivi
  <big><a target="_blank" href="mailto:martine.olivi@inria.fr">🖂</a></big>
  <big><a target="_blank" href="https://www-sop.inria.fr/members/Martine.Olivi/">🗏</a></big></li>
<li>Sabrina Barnabé
  <big><a target="_blank" href="mailto:snjazur@gmail.com">🖂</a></big>
  <big><a target="_blank" href="http://snjazur.fr">🗏</a></big></li>
<li>Thierry Viéville
  <big><a target="_blank" href="mailto:thierry.vieville@inria.fr">🖂</a></big>
  <big><a target="_blank" href="https://www-sop.inria.fr/members/Thierry.Vieville">🗏</a></big></li>
</ul></article>
</section>
......
......@@ -313,8 +313,10 @@ $(WHERE)/jsdoc_config.json: makefile
### This section allows to generate the ../README.md from the ../package.json
######################################################################################################
../README.md: ../package.json ../node_modules/package-json-to-readme/template.md $(wildcard introduction.md)
@../node_modules/.bin/package-json-to-readme ../package.json $^ | sed 's/_Generated by.*package-json-to-readme.*_//' > $@
../README.md: ../package.json $(wildcard introduction.md)
@rm -f ../node_modules/package-json-to-readme/template.md
@$(MAKE) ../node_modules/package-json-to-readme/template.md
@../node_modules/.bin/package-json-to-readme ../package.json $^ > $@
@if [ -f introduction.md ] ; then mv $@ $@~ ; (head -3 $@~ ; cat introduction.md ; tail -n +4 $@~) > $@ ; fi
define README_TEMPLATE
......
Supports Markdown
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