Skip to content

Commit

Permalink
Update README and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
mikepierce committed Dec 29, 2020
1 parent 8ed5acd commit 02266bc
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 22 deletions.
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
# Contributing

The goals of this project are to
The overarching goals of this project are to
(1) translate Grothendieck's essay from French to various other languages,
and (2) typeset those translations nicely online.
Regarding contributing to the second goal, it's the wild west:
Feel free to open an issue or start a discussion,
Feel free to open an [issue](https://github.com/mikepierce/grothendieck-kimchi/issues)
or start a [discussion](https://github.com/mikepierce/grothendieck-kimchi/discussions),
or just fork then edit then make a merge request and hope I like it 😉
Regarding the first goal though,
there are some guidelines to adhere to to keep organized.
there are some guidelines we should adhere to to keep organized.


## Guidelines on Translating

Check out the [issues page](https://github.com/mikepierce/grothendieck-kimchi/issues)
for anything that needs to be translated.
In general, to keep an organized translation workflow,
To keep an organized translation workflow,
here are a few things I'd prefer contributors keep in mind:

- **When translating, respect the linesbreaks.**
Expand All @@ -39,11 +38,10 @@ here are a few things I'd prefer contributors keep in mind:
drastic changes in the meaning of the writing.
([à la the telephone game](https://en.wikipedia.org/wiki/Telephone_(game))).
The French version can be found [scanned here](http://www.ihes.fr/~damour/IMAGE/kimchi_grothendieck.pdf)
or [typeset here](https://mikepierce.github.io/grothendieck-kimchi/translations/french/).
If you translate from the English, that's fine
or [dubiously transcribed here](https://mikepierce.github.io/grothendieck-kimchi/translations/french/).
If you translate from the English, that's okay
but we should start an issue requesting that someone who also knows French
can proofread it.

- If you'd like to talk about the accuracy of an existing translation,
bring it up on the [discussions page](https://github.com/mikepierce/grothendieck-kimchi/discussions).

25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,23 @@
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a-Coffee-orange)](https://www.buymeacoffee.com/mpierce)


# Grothendieck's Musings on Kimchi

This is a working English translation of Alexander Grothendieck's essay on kimchi.
I have little to do with the words;
I'm simply organizing/crowdsourcing the translation via GitHub.
Please feel free to
[contribute](https://github.com/mikepierce/grothendieck-kimchi/issues) anything you can!
A scan of the original French can be found
[here](http://www.ihes.fr/~damour/IMAGE/kimchi_grothendieck.pdf).
If you don't know what kimchi is, then I encourage you to
[watch this](https://youtu.be/W4hvneKcPZI).
A live, and nicely typeset, version of this translation can be found at
[mikepierce.github.io/grothendieck-kimchi](https://mikepierce.github.io/grothendieck-kimchi).
This project is an English translation and a French transcription of
[Alexander Grothendieck's essay on kimchi](http://www.ihes.fr/~damour/IMAGE/kimchi_grothendieck.pdf).
The translation is hosted at [mikepierce.github.io/grothendieck-kimchi](https://mikepierce.github.io/grothendieck-kimchi/).

If you'd like to contribute to this project
(make suggestions for this English translation,
make corrections to the French transcription,
create a new translation, improve this website, etc) see
[contributing.md](https://mikepierce.github.io/grothendieck-kimchi/)
and please add your voice to the
[discussions page](https://github.com/mikepierce/grothendieck-kimchi/discussions).


## A Similar Project

To anyone who likes translating FrenchEnglish,
To anyone who likes translating FrenchEnglish,
notice this project to [translate Grothendieck's SGA](https://github.com/jmoellermath/translate-SGAI).
2 changes: 1 addition & 1 deletion translations/english/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h2 id="title">Grothendieck&rsquo;s Musings on Kimchi</h2>
<p>
You can find a <a href="translations/french/">French transcription here</a>,
but it <a target="_blank" href="https://github.com/mikepierce/grothendieck-kimchi/issues/9">might contain errors</a>.
If you'd like to contribute to this project
If you&rsquo;d like to contribute to this project
(make suggestions for this English translation,
make corrections to the French transcription,
create a new translation, improve this website, etc) see
Expand Down

0 comments on commit 02266bc

Please sign in to comment.