Skip to content

Commit 4c6efb3

Browse files
committed
Update README.md
1 parent 35a382d commit 4c6efb3

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
11
## Dynamic Web TWAIN Documentation
22

3-
This project is to store DWT documentation.
3+
This project is to store [Dynamic Web TWAIN](https://www.dynamsoft.com/web-twain/overview/)'s documentation. The main official documentation website is hosted at <https://www.dynamsoft.com/web-twain/docs/introduction/index.html>.
4+
5+
### Local Development
6+
7+
1. Download the docs template repo and the Web TWAIN docs repo with [download-dwt.sh](https://github.com/tony-xlh/misc/raw/refs/heads/main/build-docs/download-dwt.sh).
8+
2. Install Ruby and Jekyll.
9+
3. Go to the docs' folder and install dependencies.
10+
11+
```bash
12+
bundle install
13+
```
14+
15+
4. Serve the Site.
16+
17+
```bash
18+
bundle exec jekyll serve -P 5555 --trace --host=0.0.0.0
19+
```
20+
21+
### License
22+
23+
All documentation is available under the terms of [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/).
424

5-
Set up with
625

7-
https://docs.github.com/en/enterprise/2.14/user/articles/setting-up-your-github-pages-site-locally-with-jekyll

0 commit comments

Comments
 (0)