Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,52 @@
# 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:
```
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
```
Expand All @@ -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
4) in `_site` you have the generated html
4 changes: 2 additions & 2 deletions docs/simplefoc_libraries/tools/webcontroller.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
...

}
Expand Down