From 72b37d770d74b5ec4bf37298a498ba519d58ca1a Mon Sep 17 00:00:00 2001 From: Mingwei Samuel Date: Sun, 2 Feb 2020 13:21:43 -0800 Subject: [PATCH] Add development/srcgen info to the README --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9df6bfd..269804f 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Rust Library for the [Riot Games API](https://developer.riotgames.com/). -Rivens's goals are _speed_, _reliability_, and _maintainability_. Riven handles rate limits and large requests with ease. +Riven's goals are _speed_, _reliability_, and _maintainability_. Riven handles rate limits and large requests with ease. Data structs and endpoints are automatically generated from the [Riot API Reference](https://developer.riotgames.com/api-methods/) ([Swagger](http://www.mingweisamuel.com/riotapi-schema/tool/)). @@ -122,7 +122,21 @@ not the major version. Parts of Riven that do not depend on Riot API changes do follow semantic versioning. -### Additional Info +### Additional Help Feel free to [make an issue](https://github.com/MingweiSamuel/Riven/issues/new) -if you are have any questions or trouble using Riven. +if you are have any questions or trouble with Riven. + +## Development + +NodeJS is used to generate code for Riven. The +[`srcgen/`](https://github.com/MingweiSamuel/Riven/tree/master/srcgen) +folder contains the code and [doT.js](https://olado.github.io/doT/index.html) +templates. `index.js` lists the JSON files downloaded and used to generate the +code. + +To set up the srcgen, you will first need to install NodeJS. Then enter the +srcgen folder and run `npm ci` (or `npm install`) to install dependencies. + +To run the srcgen use `node srcgen` from the main folder. +