Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daemon1024 committed Jul 23, 2021
1 parent 1c4b6dd commit 48436ff
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions scripts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Generate New Spreadsheet Layer

This directory contains scripts and logic for manual as well as automated generation of new spreadsheet based layers.

## Steps to manually generate layer

1. Create `input.json`
```sh
cp sample.input.json
```

2. Replace values in `input.json` with the data for new spreadsheet layer
3. Execute `manualGenLayer.js`
```sh
node manualGenLayer.js
```
4. Check if json files are modified inside `src/`
5. Build the entire package
```sh
grunt build
```
6. Modify example files and check if you can use the newly generated layer
```sh
npm start
```
7. Commit Files and Create Pull Request


## Automatically Generate Layer

// To be added in follow up PR

0 comments on commit 48436ff

Please sign in to comment.