Skip to content

Commit 2f7486e

Browse files
Minor improvements to the README
1 parent 4707636 commit 2f7486e

1 file changed

Lines changed: 9 additions & 20 deletions

File tree

README.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
11
# Coffin problems
22

3-
This project catalogues the so-called _Coffin problems_:
4-
mathematical problems that in the 1960s, 1970s, and 1980s
3+
_Coffin problems_ are mathematical problems that in the 1960s, 1970s, and 1980s
54
were administered at the entrance examinations of some Soviet universities
65
for the purpose of preventing the enrolment of applicants who were deemed undesirable,
76
category which mainly included people of Jewish descent.
87
The problems were given at the oral exams to the 'undesirable' candidates.
98

10-
This repository's goal is to exhaustively catalogue these problems, and to provide solutions.
11-
Some problems also admit interesting generalisations, which are also catalogued.
9+
The goal of this project is to exhaustively catalogue these problems, and to provide solutions.
10+
Some problems also admit interesting generalisations, which are also collected, separately.
1211

1312
For historical information on the topic, consult the [historical references](#additional-references).
1413

1514

1615
## Download
1716

18-
<!--
19-
> [!NOTE]
20-
> Solutions have not yet been written for all problems.
21-
-->
22-
2317
Download in PDF format:
2418
<h3 align="center">
2519
<a href="https://coffinproblems.github.io/coffins/coffins.pdf" download>
@@ -58,8 +52,6 @@ The same are also available for the **generalisations of the problems**:
5852
| Solutions | [Download](https://coffinproblems.github.io/coffins/coffins_generalised_solutions.pdf) | [Download](https://coffinproblems.github.io/coffins/coffins_generalised_solutions_minimal.pdf) | [Download](https://coffinproblems.github.io/coffins/coffins_generalised_solutions-mathml.epub) | [Download](https://coffinproblems.github.io/coffins/coffins_generalised_solutions-svg.epub) |
5953
| Problems and solutions | [Download](https://coffinproblems.github.io/coffins/coffins_generalised_problems_and_solutions.pdf) | [Download](https://coffinproblems.github.io/coffins/coffins_generalised_problems_and_solutions_minimal.pdf) | [Download](https://coffinproblems.github.io/coffins/coffins_generalised_problems_and_solutions-mathml.epub) | [Download](https://coffinproblems.github.io/coffins/coffins_generalised_problems_and_solutions-svg.epub) |
6054

61-
<br>
62-
6355

6456
## Status
6557

@@ -152,9 +144,6 @@ or change `$pdf_mode = 4` to `$pdf_mode = 1` in the `latexmkrc` file (located in
152144

153145
### Generate ebook
154146

155-
> [!WARNING]
156-
> ebook generation is currently not reliable.
157-
158147
> [!NOTE]
159148
> The following instructions utilize the [`tex4ebook`](https://github.com/michal-h21/tex4ebook) command,
160149
> which is generally already included with TeX distributions.
@@ -166,7 +155,7 @@ For generating an ebook in `EPUB3` format, run this command from within the `src
166155
tex4ebook --build-dir ../build_epub3 --output-dir ../output -f epub3 main.tex mathml
167156
```
168157
This generates the document in `EPUB` version 3, with mathematical notation encoded in the `MathML` format.
169-
> [!IMPORTANT]
158+
> [!NOTE]
170159
> The `MathML`-encoded results are currently broken:
171160
> the generated documents have incomplete formulas, and messed up text and formatting.
172161
> Encoding Maths content as `svg` or `png` produces more usable results,
@@ -210,15 +199,15 @@ They are identified by the following keywords:
210199

211200
- `NOSOLUTIONS`: to not print the solutions
212201
- `ONLYSOLUTIONS`: to only print the solutions
213-
> [!WARNING]
202+
> [!NOTE]
214203
> Setting both `NOSOLUTIONS` and `ONLYSOLUTIONS` will result in an empty document.
215204
216205
- `NOSOURCES`: to omit printing the sources at each problem statement
217206

218207
- `NOREFS`: to omit printing any references (automatically sets `NOSOURCES` as well)
219208
- `MOREREFS`: to print additional references for further reading (at the end of the document, after the main references)
220209
- `FORUMREFS`: to print references to user discussions (at the end of the document, after the other references)
221-
- `MERGEREFS`: to print the references all toghether instead of separating them in distinct lists
210+
- `MERGEREFS`: to print the references all together instead of separating them in distinct lists
222211
> [!NOTE]
223212
> `NOREFS` overrides `MOREREFS` and `FORUMREFS`.
224213
@@ -239,11 +228,11 @@ at the end of the `tex4ebook` command, like this:
239228
```shell
240229
tex4ebook --build-dir ../build_ebook_svg --output-dir ../output -f epub -e main.tex svg "" "" '\\def\\OPTION{} \\def\\OPTION{}'
241230
```
242-
> [!IMPORTANT]
231+
> [!WARNING]
243232
> Make sure to enclose the string of options in single quotes,
244233
> or escape the backslashes if using double quotes: `"\\\\def\\\\OPTION{} \\\\def\\\\OPTION{}"`.
245-
> Make sure that the string containing the options is the fifth positional argument;
246-
> if omitting the `svg` or `png` or `mathml` argument, then an extra empty string `""` is needed in its place.
234+
> Make sure that the string containing the options is the fifth positional argument of the command:
235+
> if omitting the `svg`/`png`/`mathml` argument, then an extra empty string `""` is needed in its place.
247236
248237
<br>
249238

0 commit comments

Comments
 (0)