Skip to content

Commit efe7940

Browse files
Merge pull request #21 from naikymen/patch-1
Minor changes on README.md
2 parents e47e7a7 + e2e9682 commit efe7940

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,52 @@
11
# simplefoc.github.io
2+
23
Documentation website for SimpleFOCproject
34

45
- [Documentation](https://docs.simplefoc.com)
56
- [Community forum](https://community.simplefoc.com)
67
- [Shop](https://simplefoc.com/shop)
78

8-
99
## Running the site using anaconda environement
1010

1111
Nice tutorial: https://s-canchi.github.io/2021-04-30-jekyll-conda/
1212

1313
First create the new anaconda environmnet using the `environment.yaml`file
14+
1415
```
15-
conda env create -f environment.yaml
16+
conda env create -f environement.yaml
1617
conda activate simpledocs
1718
```
1819

1920
Once in the environment `simpledocs` install jekyll
21+
2022
```
2123
gem install jekyll bundler
2224
```
25+
2326
Then install necessary jekyll dependencies of the simplefoc docs:
27+
2428
```
29+
# Optionally specify "--path /some/other/dir" to avoid needing root.
2530
bundle install
2631
```
32+
2733
And you're ready to go!
2834

2935
Just make sure that whenever you open your terminal to generate the website to activate the conda environment:
3036
```
3137
conda activate simpledocs
3238
```
3339

34-
35-
## Generating the website
40+
## Generating the website
3641

3742
To generate the site locally clone the repo to your local directory and then open terminal inside the repo folder and run:
43+
3844
```
3945
bundle exec jekyll serve
4046
```
47+
4148
Since the site is quiet large sometimes the `--incremental` flag helps with faster execution
49+
4250
```
4351
bundle exec jekyll serve --incremental
4452
```
@@ -50,4 +58,4 @@ bundle exec jekyll serve --incremental
5058
- `url: "http://olddocs.simplefoc.com" `
5159
- `baseurl: "v2.2.3"`
5260
3) run `bundle exec jekyll build`
53-
4) in `_site` you have the generated html
61+
4) in `_site` you have the generated html

docs/simplefoc_libraries/tools/webcontroller.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ void setup(){
7272
// add the motor to the commander interface
7373
// The letter id (here 'M') of the motor
7474
char motor_id = 'M';
75-
command.add(motor_id,doMotor,'motor');
75+
command.add(motor_id,doMotor,"motor");
7676
// tell the motor to use the monitoring
7777
motor.useMonitoring(Serial);
7878
// configuring the monitoring to be well parsed by the webcontroller
7979
motor.monitor_start_char = motor_id; // the same latter as the motor id in the commander
8080
motor.monitor_end_char = motor_id; // the same latter as the motor id in the commander
8181

82-
commander.verbose = VerboseMode::machine_readable; // can be set using the webcontroller - optional
82+
command.verbose = VerboseMode::machine_readable; // can be set using the webcontroller - optional
8383
...
8484

8585
}

0 commit comments

Comments
 (0)