Skip to content

Commit 4aa7e9f

Browse files
committed
updated readme
1 parent 42f3d71 commit 4aa7e9f

File tree

1 file changed

+28
-27
lines changed

1 file changed

+28
-27
lines changed

README.md

+28-27
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,46 @@
1-
MetaPost + ConTeXt rendition of [Oliver Byrne's "The first six books of the
2-
Elements of
3-
Euclid"](https://en.wikipedia.org/wiki/Oliver_Byrne_(mathematician)#Byrne.27s_Euclid)
1+
MetaPost + TeX rendition of [Oliver Byrne's "The first six books of the
2+
Elements of Euclid"](https://en.wikipedia.org/wiki/Oliver_Byrne_(mathematician)#Byrne.27s_Euclid)
43

54
![title](https://user-images.githubusercontent.com/7447349/41129584-737480dc-6abb-11e8-8f73-7b9a9afcb38a.png)
65

76
This project is not intended to create the exact copy of the original, but
87
rather is an attempt to implement all its most important features in a way that
98
would allow easy modification and creation of similarly styled geometric proofs.
109

10+
At the moment, all the code for this purpose exists as a standalone LaTeX
11+
[package](https://github.com/jemmybutton/byrne-latex), is
12+
[on CTAN](https://www.ctan.org/pkg/byrne),and can be used by employing
13+
`\usepackage{byrne}`.
14+
1115
![comparison](https://user-images.githubusercontent.com/7447349/52147564-2c240580-2678-11e9-9803-01a2b7c970da.png)
1216

13-
This version of the book is made in a way that makes modifications, including
14-
translation, quite possible and even not that difficult. As a proof of concept
15-
Russian translation was made. Plus, although Byrne's book looks cool as it is,
16-
it might be helpful, as Edward Tufte points out, to supplement it with
17-
conventional letter designations. So, there's also option for that (it is turned
18-
on by default in the Russian version and can be easily turned on in the English
19-
version).
17+
Beyond merely reproducing Byrne's original design elements, this version
18+
features some improvments over the original. E.g., it has a mechanism to
19+
add small letters to Byrne's colorful diagrams, as suggested by Edward
20+
Tufte in [Envisioning Information](https://www.edwardtufte.com/tufte/books_ei).
21+
This feature is turned on by default in the Russian version and can be
22+
turned on with one line in the English version (save for some layout
23+
changes which arise due to letter designations taking more space).
2024

2125
![labels](https://user-images.githubusercontent.com/7447349/52147400-a30cce80-2677-11e9-9a2a-3b7f88419c90.png)
2226

23-
In addition to all the colorful byrnian stuff, this edition features generated
24-
lettrines and vignettes, so there are no two identical initials in the whole
25-
book.
27+
This edition features generated initials and vignettes, so there are no
28+
two identical initials in the whole book. This feature is pretty much
29+
work-in-progress, and, when ready (i.e. when it starts producing
30+
satisfactory results), is likely to become a part of
31+
[fiziko](https://github.com/jemmybutton/fiziko) library.
2632

2733
![lettrines](https://user-images.githubusercontent.com/7447349/52147399-a2743800-2677-11e9-83a1-d25620253263.png)
2834

29-
The book itself (byrne_context.tex) and Russian translation
30-
(byrne_ru_context.tex) are licensed under CC-BY-SA 4.0.
31-
32-
MetaPost library (byrne.mp) and lettrines generator (lettrines.mp) are licensed
33-
under GPLv3 or later.
35+
The book itself (byrne-en-latex.tex) and its Russian translation
36+
(byrne-ru-latex.tex) are licensed under CC-BY-SA 4.0.
3437

35-
To build the book from command line run `context byrne_context.tex` within the
36-
book directory. To generate lettrines run `mpost lettrines.mp` within
37-
`\lettrines` directory.
38+
MetaPost library (byrne.mp) and initials generator (lettrines.mp) are
39+
licensed under GPLv3 or later.
3840

39-
See releases for prepared .pdfs. See Actions for fresher pdfs (unless
40-
they are expired).
41+
To build the book run `lualatex byrne-en-latex.tex` or
42+
`lualatex byrne-ru-latex.tex` within the book directory. To generate the
43+
initials run `mpost lettrines.mp` within `\lettrines` directory.
4144

42-
Update: the project is moving from ConTeXt to LuaLaTeX. At the moment
43-
it's not finished, and some features do not work yet (e.g. generated
44-
initials). Actions produce LaTeX versions now, so expect them to be
45-
a little bit more rough.
45+
See releases for prepared .pdfs (at the moment it's an older ConTeXt
46+
version). See Actions for fresher pdfs (unless they are expired).

0 commit comments

Comments
 (0)