From d684be1af9ca413b93acc0b5dd968d90c4e3d2d9 Mon Sep 17 00:00:00 2001 From: askuric Date: Wed, 27 Sep 2023 11:17:31 +0200 Subject: [PATCH 1/2] typo in webcontroller code --- docs/simplefoc_libraries/tools/webcontroller.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/simplefoc_libraries/tools/webcontroller.md b/docs/simplefoc_libraries/tools/webcontroller.md index 9b11845..e0b3374 100644 --- a/docs/simplefoc_libraries/tools/webcontroller.md +++ b/docs/simplefoc_libraries/tools/webcontroller.md @@ -72,14 +72,14 @@ void setup(){ // add the motor to the commander interface // The letter id (here 'M') of the motor char motor_id = 'M'; - command.add(motor_id,doMotor,'motor'); + command.add(motor_id,doMotor,"motor"); // tell the motor to use the monitoring motor.useMonitoring(Serial); // configuring the monitoring to be well parsed by the webcontroller motor.monitor_start_char = motor_id; // the same latter as the motor id in the commander motor.monitor_end_char = motor_id; // the same latter as the motor id in the commander - commander.verbose = VerboseMode::machine_readable; // can be set using the webcontroller - optional + command.verbose = VerboseMode::machine_readable; // can be set using the webcontroller - optional ... } From e2e96825fb474b52108ecda9bacdb0a782a39538 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20A=2E=20M=C3=A9ndez?= Date: Sun, 12 Nov 2023 21:31:40 -0300 Subject: [PATCH 2/2] Update README.md The environment file is named "environement.yaml" (SIC). Note that option --path to bundle can be used to skip root permissions --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cbca440..950b296 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,35 @@ # simplefoc.github.io + Documentation website for SimpleFOCproject - [Documentation](https://docs.simplefoc.com) - [Community forum](https://community.simplefoc.com) - [Shop](https://simplefoc.com/shop) - ## Running the site using anaconda environement Nice tutorial: https://s-canchi.github.io/2021-04-30-jekyll-conda/ First create the new anaconda environmnet using the `environment.yaml`file + ``` -conda env create -f environment.yaml +conda env create -f environement.yaml conda activate simpledocs ``` Once in the environment `simpledocs` install jekyll + ``` gem install jekyll bundler ``` + Then install necessary jekyll dependencies of the simplefoc docs: + ``` +# Optionally specify "--path /some/other/dir" to avoid needing root. bundle install ``` + And you're ready to go! Just make sure that whenever you open your terminal to generate the website to activate the conda environment: @@ -31,14 +37,16 @@ Just make sure that whenever you open your terminal to generate the website to a conda activate simpledocs ``` - -## Generating the website +## Generating the website To generate the site locally clone the repo to your local directory and then open terminal inside the repo folder and run: + ``` bundle exec jekyll serve ``` + Since the site is quiet large sometimes the `--incremental` flag helps with faster execution + ``` bundle exec jekyll serve --incremental ``` @@ -50,4 +58,4 @@ bundle exec jekyll serve --incremental - `url: "http://olddocs.simplefoc.com" ` - `baseurl: "v2.2.3"` 3) run `bundle exec jekyll build` -4) in `_site` you have the generated html \ No newline at end of file +4) in `_site` you have the generated html