Skip to content

Commit e2e9682

Browse files
authored
Update README.md
The environment file is named "environement.yaml" (SIC). Note that option --path to bundle can be used to skip root permissions
1 parent d684be1 commit e2e9682

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
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

0 commit comments

Comments
 (0)