# vox-install


**NOTA** : Este módulo está en etapa de prueba y está sujeto a cambios antes de su versión release. Por favor no use este módulo aún


** **

Vox-install es un módulo parte de vox, encargado de realizar la parte final de la instalación.


**NOTA** : A partir de la versión 0.1.0 se añadió soporte para Osx

**NOTA** : La opción de crear un script que inicie con el sistema operativo no funciona aún en Linux. Se agradece aportes en este tema

**NOTA** : En próximas versiones se modificará la estructura del archivo *vox.config.json* levemente, para reflejar un mejor orden. La configuración actual seguiría funcionando.


vox-install lee el archivo *vox.config.json* de su proyecto y a partir de él crea accesos directos, con íconos, coloca ejecutables, y si la configuración lo determina, crea una entrada para que se ejecute al iniciar el Sistema Operativo

El README anterior no reflejaba bien el argumento *id*, tenga en cuenta que debe ser compuesto por tres palabras unidas con `punto`. Como en este ejemplo: *org.voxsoftware.icevw*


### Lista de cambios

- [Cambios](/CHANGES.md)

### Archivo de configuración

El archivo de configuración se debe llamar vox.config.js dentro de su carpeta del módulo y debe tener una estructura como la siguiente:


```json
{
    "bin":{
        "icevw": {
            "onstart":true,
            "staronfinish":true,
            "menudir": "VoxSoftware",
            "icon":{
                "register": true,
                "icon": "voxsoftware-icevw.png",
                "size": "96",
                "winicon": "icevw.ico",
                "vendor":true
            },
            "categories": ["Programming", "Network", "Application"],
            "name": "IceVW",
            "id": "org.voxsoftware.icevw",
            "comment": "Utilice recursos del equipo desde la web",
            "mimetype": [],
            "exec":"index.coffee"
        }
    }
}
```


### Licencia
MIT License