Skip to content

Commit

Permalink
upgrade docs to add docker
Browse files Browse the repository at this point in the history
  • Loading branch information
alberto-bottarini committed Jan 16, 2025
1 parent 3f68323 commit 422dbe5
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,10 +191,24 @@ These can be used in a card's `text` section. It will get converted to the appro

#### Translations

To merge new changes in default language in all locales, run the CoffeeScript script `update_locales`.
To merge new changes in default language in all locales, run the CoffeeScript script `update_locales`. You could install dependency locally or you could use docker.

##### Local installation
Pre-requisites:
* `node` and `npm` installed
* `npm -g install coffee-script`

Usage: `coffee update_locales.coffee`
Usage:

`coffee update_locales.coffee`

##### Docker
Pre-requisites:
* [Docker](https://www.docker.com/)

Usage:

```
docker run -it --rm -v "$PWD":/usr/src/app -w /usr/src/app node:22 npm install
docker run -it --rm -v "$PWD":/usr/src/app -w /usr/src/app node:22 ./node_modules/coffee-script/bin/coffee update_locales.coffee
```
9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
"dependencies": {
"lodash": "^4.13.1",
"mkdirp": "^0.5.1"
"coffee-script": "^1.12.7",
"lodash": "^4.13.1",
"mkdirp": "^0.5.1"
}
}
}

0 comments on commit 422dbe5

Please sign in to comment.