Improving README documentation #4

README.md

@@ -7,15 +7,13 @@ Transliterate español (spanish) spelling to andaluz electron app transcriptor.
 ## Table of Contents
 
 - [Description](#description)
+- [Run](#run)
+- [Build](#build)
 - [Installation](#installation)
-  - [DEB](#deb)
-  - [AppImage](#appimage)
+  - [deb](#deb)
+  - [rpm](#rpm)
   - [Snap](#snap)
-  - [RPM](#rpm)
-- [Usage](#usage)
-  - [Requirements](#requirements)
-  - [Development](#development)
-  - [Build](#build)
+  - [appImage](#appimage)
 - [Support](#support)
 - [Contributing](#contributing)
 
@@ -27,16 +25,153 @@ This app uses the [Andaluh-js](https://github.com/andalugeeks/andaluh-js).
 
 As there's no official or standard andaluz spelling, andaluh-js is adopting the **EPA proposal (Er Prinzipito Andaluh)**. Further info: https://andaluhepa.wordpress.com. Other andaluz spelling proposals are planned to be added as well.
 
+## Run
+
+Andaluh-electron requires `nodejs` >= 12.x.x to run. Running is as simple as installing dependencies with `npm install` and then running the scripts `npm run-script start:react` and `npm run-script start:electron` as follows:
+
+```
+$ npm install
+
+> [email protected] postinstall ~/andaluh-electron/node_modules/babel-runtime/node_modules/core-js
+> node -e "try{require('./postinstall')}catch(e){}"
+
+Thank you for using core-js ( https://github.com/zloirock/core-js ) for polyfilling JavaScript standard library!
+
+The project needs your help! Please consider supporting of core-js on Open Collective or Patreon: 
+> https://opencollective.com/core-js 
+> https://www.patreon.com/zloirock 
+
+Also, the author of core-js ( https://github.com/zloirock ) is looking for a good job -)
+
+
+> [email protected] postinstall ~/andaluh-electron/node_modules/core-js
+> node -e "try{require('./postinstall')}catch(e){}"
+
+
+> [email protected] postinstall ~/andaluh-electron/node_modules/core-js-pure
+> node -e "try{require('./postinstall')}catch(e){}"
+
+
+> [email protected] postinstall ~/andaluh-electron/node_modules/electron
+> node install.js
+
+
+> [email protected] postinstall ~/andaluh-electron/node_modules/nodemon
+> node bin/postinstall || exit 0
+
+npm WARN [email protected] No repository field.
+npm WARN [email protected] license should be a valid SPDX license expression
+npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/webpack-dev-server/node_modules/fsevents):
+npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
+npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/watchpack-chokidar2/node_modules/fsevents):
+npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
+npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/react-scripts/node_modules/fsevents):
+npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
+npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/jest-haste-map/node_modules/fsevents):
+npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
+npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
+npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
+
+added 2114 packages from 853 contributors and audited 2119 packages in 40.051s
+
+87 packages are looking for funding
+  run `npm fund` for details
+
+found 0 vulnerabilities
+
+$ npm run-script start:react & npm run-script start:electron
+```
+
+*Note*: You may have to run the two scripts of the last command above on different terminals.
+
+## Build
+
+Thanks to `electron-builder` several packages (`deb`, `rpm`, `snap (unsigned)`, `appImage`) are build with a single command: `npm run-script build`.  You need to have the following dependencies installed in order to generate the packages: `dpkg`, `rpm`, `snap`.
+
+
+```
+$ npm run-script build
+
+> [email protected] prebuild ~/andaluh-electron
+> node tasks/prebuild.js
+
+Removing ~/andaluh-electron/build
+Removing ~/andaluh-electron/dist
+
+> [email protected] build ~/andaluh-electron
+> npm run build:react && npm run build:electron
+
+
+> [email protected] build:react ~/andaluh-electron
+> react-scripts build
+
+Creating an optimized production build...
+Compiled successfully.
+
+File sizes after gzip:
+
+  134.07 KB  build/static/js/2.8b009245.chunk.js
+  12.68 KB   build/static/js/main.7e1f83c8.chunk.js
+  780 B      build/static/js/runtime-main.edf38bd2.js
+  159 B      build/static/css/main.8f082792.chunk.css
+
+The project was built assuming it is hosted at ./.
+You can control this with the homepage field in your package.json.
+
+The build folder is ready to be deployed.
+
+Find out more about deployment here:
+
+  bit.ly/CRA-deploy
+
+
+> [email protected] build:electron ~/andaluh-electron
+> electron-builder
+
+  • electron-builder  version=22.8.1 os=4.15.0-118-generic
+  • loaded configuration  file=package.json ("build" field)
+  • writing effective config  file=dist/builder-effective-config.yaml
+  • packaging       platform=linux arch=x64 electron=10.1.2 appOutDir=dist/linux-unpacked
+  • building        target=snap arch=x64 file=dist/andaluh-transcriptor-1.0.0-amd64.snap
+  • building        target=AppImage arch=x64 file=dist/andaluh-transcriptor-1.0.0-x86_64.AppImage
+  • building        target=deb arch=x64 file=dist/andaluh-transcriptor-1.0.0-amd64.deb
+  • building        target=rpm arch=x64 file=dist/andaluh-transcriptor-1.0.0-x86_64.rpm
+```
+
 ## Installation
+
 ### DEB
-### AppImage
-### Snap
+
+For `debian` or `ubuntu` linux systems, run the following command after package build:
+
+```
+$ sudo dpkg -i dist/andaluh-transcriptor-1.0.0-amd64.deb
+```
+
 ### RPM
 
-## Usage
-### Requirements
-### Development
-### Build
+For `redhat` or `fedora` linux systems, run the following command after package build:
+
+```
+$ sudo rpm i dist/andaluh-transcriptor-1.0.0-x86_64.rpm
+``` 
+
+### Snap
+
+A cross linux distro `snap` installation package is also available. It is distributed unsigned (so far), so please use the followign command to install the snap package after build:
+
+```
+$ sudo snap install --dangerous /dist/andaluh-transcriptor-1.0.0-amd64.snap
+```
+
+### appImage
+
+A cross linux distro `appImage` executable is also available. You can just execute it as-is without installing
+
+```
+$ ./dist/andaluh-transcriptor-1.0.0-x86_64.AppImage
+```
+
 ## Support
 
 Please [open an issue](https://github.com/andalugeeks/andaluh-electron/issues/new) for support.