Changeset 35774


Ignore:
Timestamp:
2021-12-08T14:08:58+13:00 (2 years ago)
Author:
cstephen
Message:

Update READMES

Location:
main/trunk/model-interfaces-dev/atea
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • main/trunk/model-interfaces-dev/atea/korero-maori-asr/README.md

    r35509 r35774  
    55## Project setup
    66
    7 Ensure that [node.js](https://nodejs.org) is on your path. (e.g., which node)
     71. Ensure that [node.js](https://nodejs.org) is on your path. You can check this with the following:
    88
    9 You will also need to setup the Greenstone3 `koreromaori-proxy` extension. Visit https://trac.greenstone.org/browser/gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy to get the source.
     9    ```sh
     10    > command -v node
     11    ```
    1012
    11 ```
    12 npm install
    13 ```
     132. Finally, install required dependencies:
     14
     15    ```sh
     16    > npm install
     17    ```
     18
     193. Setup the Greenstone3 `koreromaori-proxy` extension. Visit https://trac.greenstone.org/browser/gs3-extensions/atea-nlp-tools/trunk/src/koreromaori-proxy to get the source.
    1420
    1521### Compile and hot-reload for development
    1622
    17 This will open a development webserver on http://localhost:8080 that is detached from the running Greenstone instance.
     23This will open a development webserver on http://localhost:8080 that is detached from the running Greenstone instance. It hot-reloads as you make changes to the files, allowing for much faster development.
    1824
    19 ```
    20 npm run serve
     25```sh
     26> npm run serve
    2127```
    2228
    2329### Compile and minify for production
    2430
    25 1. In `vue.config.js`, uncomment the `publicPath` property, and optionally change it to point to where your production distribution will be placed relative to the root `interfaces` directory.
     311. In `vue.config.js`, update the `publicPath` property if necessary.
    2632
    27332. Build the project.
    28     ```
    29     npm run build
     34
     35    ```sh
     36    > npm run build
    3037    ```
    3138
     
    3643This uses the settings in `.eslintrc.js` to lint the project, and attempts to fix mistakes accordingly.
    3744
     45```sh
     46> npm run lint
    3847```
    39 npm run lint
    40 ```
     48
    4149### Notes
    4250
  • main/trunk/model-interfaces-dev/atea/macron-restoration/README.md

    r35773 r35774  
    99## Project setup
    1010
    11 Ensure that [node.js](https://nodejs.org) is on your path. (e.g., which node)
     111. Ensure that [node.js](https://nodejs.org) is on your path. You can check this with the following:
    1212
    13 You will also need to setup the Greenstone3 `macron-restoration` extension. Visit https://trac.greenstone.org/browser/other-projects/the-macronizer/trunk to get the source, and check the [wiki page](http://wiki.greenstone.org/doku.php?id=internal:macroniser) for setup instructions.
     13    ```sh
     14    > command -v node
     15    ```
    1416
    15 ```
    16 npm install
    17 ```
     172. Finally, install required dependencies:
     18
     19    ```sh
     20    > npm install
     21    ```
     22
     233. Setup the Greenstone3 `macron-restoration` extension. Visit https://trac.greenstone.org/browser/other-projects/the-macronizer/trunk to get the source, and check the [wiki page](http://wiki.greenstone.org/doku.php?id=internal:macroniser) for setup instructions.
     24
    1825
    1926### Compile and hot-reload for development
    2027
    21 This will open a development webserver on http://localhost:8080 that is detached from the running Greenstone instance.
     28This will open a development webserver on http://localhost:8080 that is detached from the running Greenstone instance. It hot-reloads as you make changes to the files, allowing for much faster development.
    2229
    23 ```
    24 npm run serve
     30```sh
     31> npm run serve
    2532```
    2633
     
    29361. In `vue.config.js`, update the `publicPath` property if necessary.
    3037
    31 1. Build the project.
     382. Build the project.
    3239
    33     ```
    34     npm run build
     40    ```sh
     41    > npm run build
    3542    ```
    3643
     
    4148This uses the settings in `.eslintrc.js` to lint the project, and attempts to fix mistakes accordingly.
    4249
     50```sh
     51> npm run lint
    4352```
    44 npm run lint
    45 ```
  • main/trunk/model-interfaces-dev/atea/ocr/README.md

    r35734 r35774  
    55## Project setup
    66
    7 Ensure that [node.js](https://nodejs.org) is on your path. (e.g., which node)
     71. Ensure that [node.js](https://nodejs.org) is on your path. You can check this with the following:
    88
    9 You will also need to setup the Greenstone3 `macron-restoration` extension. Visit https://trac.greenstone.org/browser/other-projects/the-macronizer/trunk to get the source, and check the [wiki page](http://wiki.greenstone.org/doku.php?id=internal:macroniser) for setup instructions.
     9    ```sh
     10    > command -v node
     11    ```
    1012
    11 ```
    12 npm install
    13 ```
     132. Install required dependencies:
     14
     15    ```sh
     16    > npm install
     17    ```
     18
     193. Setup the Greenstone3 `gs3-atea-ocr` extension. Visit https://trac.greenstone.org/browser/gs3-extensions/atea-nlp-tools/trunk/src/ocr to get the source.
     20
    1421
    1522### Compile and hot-reload for development
    1623
    17 This will open a development webserver on http://localhost:8080 that is detached from the running Greenstone instance.
     24This will open a development webserver on http://localhost:8080 that is detached from the running Greenstone instance. It hot-reloads as you make changes to the files, allowing for much faster development.
    1825
    19 ```
    20 npm run serve
     26```sh
     27> npm run serve
    2128```
    2229
    2330### Compile and minify for production
    2431
    25 1. In `vue.config.js`, uncomment the `publicPath` property, and optionally change it to point to where your production distribution will be placed relative to the root `interfaces` directory.
     321. In `vue.config.js`, update the `publicPath` property if necessary.
    2633
    27342. Build the project.
    28     ```
    29     npm run build
     35
     36    ```sh
     37    > npm run build
    3038    ```
    3139
     
    3644This uses the settings in `.eslintrc.js` to lint the project, and attempts to fix mistakes accordingly.
    3745
     46```sh
     47> npm run lint
    3848```
    39 npm run lint
    40 ```
  • main/trunk/model-interfaces-dev/atea/resources/interface_atea.properties

    r35762 r35774  
    4848
    4949atea.ocr.MainPage_Download=Download
    50 atea.ocr.MainPage_EditImage=Edit Image
     50atea.ocr.MainPage_EditImage=Pre-process Image
    5151atea.ocr.MainPage_NewImage=New
    5252atea.ocr.MainPage_OCRHint=Click 'Perform OCR' to begin...
    5353atea.ocr.MainPage_PerformOCR=Perform OCR
    5454atea.ocr.MainPage_Upload=Upload an image/PDF
     55atea.ocr.MainPage_ShowThresholdedImage=Show Thresholded Image
     56atea.ocr.MainPage_ThresholdedImageDescription=Shows the processed image that was used to extract the text. If it shows significant dark areas or poor character quality it is likely that the OCR result will be innacurate.
    5557
    5658atea.ocr.EditPage_Discard=Discard Changes
Note: See TracChangeset for help on using the changeset viewer.