github-mirror/lkmpg
2
0
Fork 0
mirror of https://github.com/sysprog21/lkmpg.git synced 2024-11-22 14:48:25 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix wording

Browse Source
This commit is contained in:
Jim Huang 2021-08-09 23:46:37 +08:00
parent e800505b8f
commit cb6267e3b6
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -31,14 +31,14 @@ Now we could build document with following commands:
$ git clone https://github.com/sysprog21/lkmpg.git && cd lkmpg
# run commands
$ make all # compile pdf document
$ make html # convert to HTML
$ make clean # delete generated files
$ make all # Generate PDFdocument
$ make html # Convert TeX to HTML
$ make clean # Delete generated files
```
### Compile with Docker
The compile process could be run completely using Docker. **Using Docker is recommended, as it guarantees the same dependencies with our GitHub Actions wokrflow.
The compilation could be completed flawlessly using Docker. **Using Docker is recommended, as it guarantees the same dependencies with our GitHub Actions wokrflow.
After [install docker engine](https://docs.docker.com/engine/install/) on your machine, pulling the docker image [twtug/lkmpg](https://hub.docker.com/r/twtug/lkmpg) and compile with it.
@ -53,9 +53,9 @@ $ docker pull twtug/lkmpg
$ docker run --rm -it -v $(pwd):/workdir twtug/lkmpg
# run commands
$ make all # compile pdf document
$ make html # convert to HTML
$ make clean # delete generated files
$ make all # Generate PDF document
$ make html # Convert TeX to HTML
$ make clean # Delete generated files
```
## License