Skip to content

Commit 6d560be

Browse files
committed
update readme in tools
1 parent 774eff2 commit 6d560be

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

tools/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Use `make` to run the main commands:
2020
* `make format`: Format Markdown files for books.
2121
* `make check`: Run several checks to ensure the Markdown files are valid.
2222
* `make website`: Create different Markdown pages for the website.
23-
* `make website-preview`: Build and preview website.
23+
* `make website-preview`: Build and preview website locally.
2424
* `make website-deploy`: Build and deploy website to GitHub Pages.
2525
* `make books`: Create .epub books.
2626

@@ -94,3 +94,14 @@ For instance, run the EPUB check using:
9494
```shell
9595
epubcheck ../downloads/typescript-book.epub
9696
```
97+
98+
## How to Contribute to This E-Book
99+
100+
To contribute to this e-book, follow these steps:
101+
102+
* Update the main markdown file with your changes.
103+
* Run `make check` to ensure the linter and other checks pass.
104+
* Preview the website locally with `make website-preview` to make sure it works as expected.
105+
* Generate the e-books by running `make books`.
106+
* Submit your PR and share your awesome contributions!
107+

0 commit comments

Comments
 (0)