diff --git a/README.md b/README.md index 189951b..731f8fc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ -Document manager for germanic national museum +# Marvin -[Boilerplate](https://github.com/alexdevero/electron-react-webpack-boilerplate.git) by [Alex Devero](https://github.com/alexdevero/) +
+ +

+Document manager for Institute for Art Technology and Conservation at Germanic National Museum Nuremberg +

+
+ +## Description +Search object information for a given objectid at https://objektkatalog.gnm.de/rest_export/ and populate MS Word templates. + +## Prerequisites +You need [nodejs](https://nodejs.org/en/) for running and building. You may want to install it with nvm ([windows](https://docs.microsoft.com/de-de/windows/dev-environment/javascript/nodejs-on-windows)/ [linux](https://github.com/nvm-sh/nvm)). + +## Install +~~~sh +git clone https://github.com/rnsrk/marvin.git +cd marvin +npm i +~~~ + +## Usage +Start devServer +~~~sh +npm run start +~~~ +Build Windows / Linux executable +~~~sh +npm run package +~~~ + +## Thanks +I've used the [Boilerplate](https://github.com/alexdevero/electron-react-webpack-boilerplate.git) by [Alex Devero](https://github.com/alexdevero/) diff --git a/main.js b/main.js index 4874cf3..9e3dcc4 100644 --- a/main.js +++ b/main.js @@ -106,7 +106,8 @@ let mainMenu = Menu.buildFromTemplate( bug_link_text: 'Einen Fehler melden', license: 'MIT', description: 'App zur Dokumentverwaltung im IKK am Germanischen Nationalmuseum.', - win_options: {title: 'Über Marvin'} + win_options: {title: 'Über Marvin'}, + homepage: 'https://github.com/rnsrk/marvin' }) } }