Skip to content

Commit 0037d38

Browse files
committed
Update README.md.
1 parent 8b2ab33 commit 0037d38

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ There is no new or extra features than original Bootstrap 3 and no new feature r
2727

2828
## Limitations
2929

30-
This repo. use CSS variable for example `--background-color: #fff;` and `background-color: var(--background-color);`. So, it does not supported Internet Explorer (IE). If you would like to use old browsers, please use original Bootstrap 3.
30+
This repo. uses CSS variables, for example `--background-color: #fff;` and `background-color: var(--background-color);`. So, it does not support Internet Explorer (IE). If you would like to use old browsers, please use original Bootstrap 3.
3131

3232

3333
## Quick start
@@ -72,7 +72,7 @@ We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified
7272

7373
Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/rundiz/bootstrap3/blob/v3-dev/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/rundiz/bootstrap3/issues/new).
7474

75-
Do not accept feature requests. This repository is for make Bootstrap 3 using modern functions, syntax to use with moder web browsers but keep original features of Bootstrap 3. No new feature requests.
75+
Do not accept feature requests. This repository is for makeing Bootstrap 3 using modern functions, and syntax to use with modern web browsers but keep the original features of Bootstrap 3. No new feature requests.
7676

7777
## Documentation
7878

@@ -88,12 +88,12 @@ Bootstrap's documentation, included in this repo in the root directory, is built
8888

8989
#### Use Docker (recommended)
9090
1. Install [Docker](https://www.docker.com/).
91-
2. From the root `/bootstrap` directory, run command `docker build -t mynode:latest .` to install **Dockerfile**.
92-
3. Run command `docker volume create docker_ruby_bundle` to create volume.
93-
4. Run command `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app mynode:latest sh -lc "gem install -N bundler -v 2.6.9 -i /bundle && bundle _2.6.9_ install"` to install Ruby gems once. You may replace `%CD%` to `$PWD` on Linux.
91+
2. From the root `/bootstrap` directory, run the command `docker build -t mynode:latest .` to install **Dockerfile**.
92+
3. Run the command `docker volume create docker_ruby_bundle` to create a volume.
93+
4. Run the command `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app mynode:latest sh -lc "gem install -N bundler -v 2.6.9 -i /bundle && bundle _2.6.9_ install"` to install Ruby gems once. You may replace `%CD%` with `$PWD` on Linux.
9494
If you see _cannot load such file -- webrick_, run this command once `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app mynode:latest sh -lc "bundle add webrick"`.
95-
5. From the root `/bootstrap` directory, run command `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app -p 9001:9001 mynode:latest bundle exec jekyll serve --host 0.0.0.0 --port 9001`
96-
Or you may use command `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app -p 9001:9001 -p 35729:35729 mynode:latest bundle exec jekyll serve --host 0.0.0.0 --port 9001 --watch --force_polling --livereload --livereload-port 35729` to make it auto regenerate the document and live reload on Windows.
95+
5. From the root `/bootstrap` directory, run the command `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app -p 9001:9001 mynode:latest bundle exec jekyll serve --host 0.0.0.0 --port 9001`
96+
Or you may use the command `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app -p 9001:9001 -p 35729:35729 mynode:latest bundle exec jekyll serve --host 0.0.0.0 --port 9001 --watch --force_polling --livereload --livereload-port 35729` to make it auto regenerate the document and live reload on Windows.
9797
6. Open `http://localhost:9001/docs/3.4/` in your browser.
9898

9999
Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/).
@@ -114,25 +114,25 @@ Editor preferences are available in the [editor config](https://github.com/rundi
114114
Recommend to use Docker to run Node package commands (`npm run ..`).
115115

116116
1. Install [Docker](https://www.docker.com/).
117-
2. From the root `/bootstrap` directory, run command `docker build -t mynode:latest .` to install **Dockerfile**. (If you already did from step Running documentation locally then you can skip this step.)
117+
2. From the root `/bootstrap` directory, run the command `docker build -t mynode:latest .` to install **Dockerfile**. (If you already did from step Running documentation locally, then you can skip this step.)
118118
3. Run commands `docker volume create docker_node_modules`, `docker volume create docker_ruby_bundle` to create volumes. (If some volume is already created then you can skip it.)
119-
4. Run command `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -w /app mynode:latest npm ci` to clean install Node packages once. You may replace `%CD%` to `$PWD` on Linux.
120-
5. Run command `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app mynode:latest bundle install` to install Ruby gems once. (If you already did from step Running documentation locally then you can skip this step.)
121-
6. And then you can run command in package.json `scripts`. For example: `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -v docker_ruby_bundle:/bundle -w /app mynode:latest npm run release`.
119+
4. Run the command `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -w /app mynode:latest npm ci` to clean install Node packages once. You may replace `%CD%` to `$PWD` on Linux.
120+
5. Run the command `docker run --rm -it -v "%CD%:/app" -v docker_ruby_bundle:/bundle -w /app mynode:latest bundle install` to install Ruby gems once. (If you already did from the step Running documentation locally, then you can skip this step.)
121+
6. And then you can run the command in package.json `scripts`. For example: `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -v docker_ruby_bundle:/bundle -w /app mynode:latest npm run release`.
122122

123123
#### To watch .less file change or compile files
124124

125-
After you completed install step 1 to 5 above, you can use following commands.
125+
After you have completed installation steps 1 to 5 above, you can use the following commands.
126126

127-
* Run command `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -v docker_ruby_bundle:/bundle -w /app mynode:latest node_modules/grunt/bin/grunt watch:less` to watch .less file change. You need to use this command to work with **Running documentation locally** live reload.
128-
* Run command `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -v docker_ruby_bundle:/bundle -w /app mynode:latest node_modules/grunt/bin/grunt dist-css` to build CSS files.
129-
* Run command `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -v docker_ruby_bundle:/bundle -w /app mynode:latest node_modules/grunt/bin/grunt dist` to build full distribution task files (CSS, JS).
127+
* Run the command `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -v docker_ruby_bundle:/bundle -w /app mynode:latest node_modules/grunt/bin/grunt watch:less` to watch .less file change. You need to use this command to work with **Running documentation locally** live reload.
128+
* Run the command `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -v docker_ruby_bundle:/bundle -w /app mynode:latest node_modules/grunt/bin/grunt dist-css` to build CSS files.
129+
* Run the command `docker run --rm -it -v "%CD%:/app" -v docker_node_modules:/app/node_modules -v docker_ruby_bundle:/bundle -w /app mynode:latest node_modules/grunt/bin/grunt dist` to build full distribution task files (CSS, JS).
130130

131131
#### Before commit, publish
132132

133-
* Run package.json `change-version` if need.
134-
* Run package.json `test` if need.
135-
* Run package.json `release` to rebuild assets, generate release zip, update hash.
133+
* Run package.json `change-version` if needed.
134+
* Run package.json `test` if needed.
135+
* Run package.json `release` to rebuild assets, generate release zip, update the hash.
136136
* Then run `git add ...` and `git commit ...`.
137137

138138

0 commit comments

Comments
 (0)