Update documentation
This commit is contained in:
parent
697a2ba56c
commit
c5f0a240c7
3 changed files with 16 additions and 5 deletions
|
@ -51,9 +51,10 @@ The preferred way to add your theme is via a Pull Request. A Pull Request is les
|
||||||
2) Go to `assets/themes` and create a new directory `yourtheme`
|
2) Go to `assets/themes` and create a new directory `yourtheme`
|
||||||
3) Create a new file `yourtheme.json`, paste the theme configuration in there. You can find your theme configuration in the customThemeBuilder (the tab with the *Floppy disk* icon)
|
3) Create a new file `yourtheme.json`, paste the theme configuration in there. You can find your theme configuration in the customThemeBuilder (the tab with the *Floppy disk* icon)
|
||||||
4) Copy all the images into this new directory. **No external sources are allowed!** External image sources leak privacy or can break.
|
4) Copy all the images into this new directory. **No external sources are allowed!** External image sources leak privacy or can break.
|
||||||
- Make sure the license is suitable, preferable a Creative Commons license. Attribution can be added at the bottom of this document
|
- Make sure the license is suitable, preferable a Creative Commons license or CC0-license.
|
||||||
- If an SVG version is available, use the SVG version
|
- If an SVG version is available, use the SVG version
|
||||||
- Make sure all the links in `yourtheme.json` are updated. You can use `./assets/themes/yourtheme/yourimage.svg` instead of the HTML link
|
- Make sure all the links in `yourtheme.json` are updated. You can use `./assets/themes/yourtheme/yourimage.svg` instead of the HTML link
|
||||||
|
- Create a file `license_info.json` in the theme directory, which contains metadata on every artwork source
|
||||||
5) Add your theme to the code base:
|
5) Add your theme to the code base:
|
||||||
- Open [AllKnownLayouts.ts](https://github.com/pietervdvn/MapComplete/blob/master/Customizations/AllKnownLayouts.ts)
|
- Open [AllKnownLayouts.ts](https://github.com/pietervdvn/MapComplete/blob/master/Customizations/AllKnownLayouts.ts)
|
||||||
- Add an import statement, e.g. `import * as yourtheme from "../assets/themes/yourtheme/yourthemes.json";`
|
- Add an import statement, e.g. `import * as yourtheme from "../assets/themes/yourtheme/yourthemes.json";`
|
||||||
|
|
|
@ -3,9 +3,9 @@
|
||||||
"Stijn Wens"
|
"Stijn Wens"
|
||||||
],
|
],
|
||||||
"path": "bicycle.svg",
|
"path": "bicycle.svg",
|
||||||
"license": "?",
|
"license": "CC0",
|
||||||
"sources": [
|
"sources": [
|
||||||
"https://wens.be/free-antwerpenize-bicycle-font",
|
"https://wens.be/free-antwerpenize-bicycle-font",
|
||||||
" https://antwerpenize.be/post/634396003556081664/antwerpenize-lettertype"
|
" https://antwerpenize.be/post/634396003556081664/antwerpenize-lettertype"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
10
tslint.json
Normal file
10
tslint.json
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
{
|
||||||
|
"defaultSeverity": "error",
|
||||||
|
"extends": [
|
||||||
|
"tslint:recommended",
|
||||||
|
"tslint-no-circular-imports"
|
||||||
|
],
|
||||||
|
"jsRules": {},
|
||||||
|
"rules": {},
|
||||||
|
"rulesDirectory": []
|
||||||
|
}
|
Loading…
Reference in a new issue