---
README.md | 31 +++++++++++++++++++++++++------
1 file changed, 25 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 928a58a..0b18ecf 100644
--- a/README.md+++ b/README.md
@@ -6,12 +6,31 @@
`codegouvfr` stands for [code.gouv.fr](https://code.gouv.fr). This repository helps creating
`json/svg/xml` files used by the [code.gouv.fr](https://git.sr.ht/~etalab/code.gouv.fr) web application.
--# Requisites--`codegouvfr-consolidate-data` needs the `vl2svg` executable:-- ~$ npm install -g vega-lite+# Installation and configuration++1. Install a Java runtime for Java version 8 or 11 if needed. You can check the existing version of your java runtime with `java -version`. [OpenJDK](https://openjdk.java.net/install/) 11 can be installed on Debian-compatible Linux systems with `apt install openjdk-11-jdk`.+2. Install Node.js if needed.+3. Install clojure: [follow installation instructions on clojure.org](https://clojure.org/guides/getting_started).+4. Install rlwrap. For example on Debian-compatible Linux systems with `apt install rlwrap`.+5. Install vl2svg with the following command `npm install -g vega-lite`.+6. Clone this repository: `git clone https://git.sr.ht/~etalab/codegouvfr-consolidate-data ; cd codegouvfr-consolidate-data`++# Generate consolidated files++1. You need input files. These input files are in the data folder of [codegouvfr-fetch-data](https://git.sr.ht/~etalab/codegouvfr-fetch-data). Copy then in the project directory. For example `cp -r ../codegouvfr-fetch-data/* .` If you skip this step, the input files will be fetched from [code.gouv.fr](https://code.gouv.fr)+2. Launch the command `clj -M:run`, the following files will be made available in the project directory:++- deps-orgas.json+- deps-repos-sim.json+- deps-repos.json+- deps-top.json+- deps-total.json+- deps.json+- orgas.json+- repos-deps.json+- repos.json+- reuses.json+- latest.xml# Get the data
--
2.30.0
Applied, thanks.
Note that the patch prefix was wrong: it needs to be
[PATCH codegouvfr-consolidate-data].
Also, we will perhaps write coding conventions later on, but
I'd rather have commit messages start with a capitalized letter:
"added installation instructions in README.md"
Just a nitpick.
Thanks!
--
Bastien Guerry
Thanks!
For the patch prefix, I just followed the doc :) Sorry I am not yet accustomed to git-email.
I will propose a small fix for this.
Ok for the commit message, I will pay attention next time. If they are other best practices or rules about commit messages on these projects, it might be interesting to enforce them with a pre-commit hook and a tool like commitlint: https://commitlint.js.org
Have a nice day,
Alain
-----Original Message-----
From: ~etalab/codegouvfr-devel <~etalab/codegouvfr-devel@lists.sr.ht> On Behalf Of Bastien Guerry
Sent: Thursday, December 2, 2021 22:17
To: Alain Vagner <alain.vagner@sous-anneau.org>
Cc: ~etalab/codegouvfr-devel@lists.sr.ht
Subject: Re: [PATCH code.gouv.fr] added installation instructions in README.md
Applied, thanks.
Note that the patch prefix was wrong: it needs to be [PATCH codegouvfr-consolidate-data].
Also, we will perhaps write coding conventions later on, but I'd rather have commit messages start with a capitalized letter:
"added installation instructions in README.md"
Just a nitpick.
Thanks!
--
Bastien Guerry
Hi Alain,
Alain Vagner <Alain.Vagner@sip.etat.lu> writes:
> For the patch prefix, I just followed the doc :) Sorry I am not yet> accustomed to git-email.
Er, my bad, the README.md was indeed wrong wrt prefix instructions, I
just fixed this.
Also, I do appreciate the effort to get accustomed to this (new) way
of contributing - I think this is for the best in the long run.
> Ok for the commit message, I will pay attention next time.
Yeah, no big deal at all.
> If they are> other best practices or rules about commit messages on these projects,> it might be interesting to enforce them with a pre-commit hook and a> tool like commitlint: https://commitlint.js.org
I don't want to overengineer this, at least as long as we are a few
contributors: most "rules" are soft ones, and we can have this kind of
quick human exchange when needed.
But I'll look into https://commitlint.js.org, which I didn't know,
and we can keep this in mind.
Thanks!
--
Bastien Guerry