You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-36Lines changed: 3 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,46 +14,13 @@ It is especially helpful for students, engineers and scientists to organize algo
14
14
15
15
In order to collaboratively take advantage of this material, usage in the following forms are welcomed:
16
16
17
-
- Preview the documentation online, see [outlines](preface.md)
18
-
- Download the [pdf](), [epub]() or [raw html]() versions of the algorithm handbook for self-learning or redistribution under the license constraint.
17
+
- Preview the documentation online, see [outlines](SUMMARY.md)
18
+
- Download the [pdf], [epub] or [raw html] versions of the algorithm handbook for self-learning or redistribution under the license constraint.
19
19
- Clone or Fork this repo to build your own flavor of algorithm handbook or to submit Pull Request.
20
20
21
-
### Prerequisites
22
-
23
-
*[pandoc](http://pandoc.org/) should be installed.
24
-
*[wkhtmltopdf](https://wkhtmltopdf.org/index.html) should be downloaded and installed.
25
-
26
-
In Mac OS X system,
27
-
*[MacTex](http://www.tug.org/mactex/), if the distribution is too big for you, consider its smaller subset [basicTex](http://www.tug.org/mactex/morepackages.html).
28
-
29
-
In Unix/Linux system,
30
-
*[TexLive](http://www.tug.org/texlive/acquire-netinstall.html) is required for font generation.
31
-
32
-
### Build from Source
33
-
34
-
In your **terminal**, run
35
-
36
-
```bash
37
-
$ alias chrome="PATH/TO/YOUR/CHROME_DESKTOP_BROWSER_APP"
38
-
```
39
-
40
-
and type in the following command (make sure you have _bash_ 4.0+ installed)
41
-
42
-
```bash
43
-
$ . build.sh
44
-
```
45
-
46
-
to supply _options_ --html, --pdf or --epub to generate the corresponding ebook versions for _interactive prompts_ or
47
-
48
-
```bash
49
-
$ . build.sh [--html|--pdf|--epub]
50
-
```
51
-
52
-
to achieve the same effects. Then, the versions you desire are built under the _out_ directory.
53
-
54
21
## Contributing
55
22
56
-
Make sure you follow the [contributing guide](.github/CONTRIBUTING.md) in order to proceed with any forms of contribution.
23
+
Make sure you follow the [contributing guide](../.github/CONTRIBUTING.md) in order to proceed with any forms of contribution.
0 commit comments