이 번역본은 2017년 7월경부터 번역된 2nd edition을 기반으로 하고 있으며, 완료된 상태입니다. 문서의 최신 버전은 https://github.com/rust-kr/doc.rust-kr.org에서 진행하고 있습니다. 최신 문서에 대한 정보는 rust-kr에 있는 저장소에서 확인해주세요.
이 저장소는 최신 버전의 문서 번역이 완료될때까지 계속 유지될 것이며 그동안의 2판 관련 오타 수정 등의 issue 및 pull-request만 처리될 예정입니다.
안녕하세요? 한국어를 쓰시는 러스트 유저 여러분들을 환영합니다. 이 저장소는 러스트 프로그래밍 언어 문서(소위 the book이라고 일컫는)의 2번째 판 번역을 위해 fork 되었습니다. 2번째 판의 빌드된 문서는 상단의 링크를 통해 읽으실 수 있습니다.
This repo contains two editions of “The Rust Programming Language”.
The second edition is a rewrite that will be printed by NoStarch Press, available around October 2017.
You can read it online; the last few chapters aren't completed yet, but the first half of the book is much improved from the first edition. We recommend starting with the second edition.
The first edition is still available to read online.
Building the book requires mdBook >= v0.0.13. To get it:
$ cargo install mdbook
To build the book, first cd
into either the first-edition
or
second-edition
directory depending on which edition of the book you would
like to build. Then type:
$ mdbook build
The output will be in the book
subdirectory. To check it out, open it in
your web browser.
Firefox:
$ firefox book/index.html # Linux
$ open -a "Firefox" book/index.html # OS X
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
$ start firefox.exe .\book\index.html # Windows (Cmd)
Chrome:
$ google-chrome book/index.html # Linux
$ open -a "Google Chrome" book/index.html # OS X
$ Start-Process "chrome.exe" .\book\index.html # Windows (PowerShell)
$ start chrome.exe .\book\index.html # Windows (Cmd)
To run the tests:
$ mdbook test
We'd love your help! Please see CONTRIBUTING.md to learn about the kinds of contributions we're looking for.
We'd especially love help translating the second edition of the book! See the Translations label to join in efforts that are currently in progress. Open a new issue to start working on a new language! We're waiting on mdbook support for multiple languages before we merge any in, but feel free to start! The chapters in the frozen column of the project won't see major changes, so if you start with those, you won't have to redo work :)
As the second edition of the book will be published by No Starch, we first iterate here, then ship the text off to No Starch. Then they do editing, and we fold it back in.
As such, there’s a directory, nostarch, which corresponds to the text in No Starch’s system.
When we've started working with No Starch in a word doc, we will also check those into the repo in the nostarch/odt directory. To extract the text from the word doc as markdown in order to backport changes to the online book:
- Open the doc file in LibreOffice
- Accept all tracked changes
- Save as Microsoft Word 2007-2013 XML (.docx) in the tmp directory
- Run
./doc-to-md.sh
- Inspect changes made to the markdown file in the nostarch directory and copy the changes to the src directory as appropriate.
This is mostly for Carol's reference because she keeps having to look it up.
We're using Graphviz for some of the diagrams in the
book. The source for those files live in the dot
directory. To turn a dot
file, for example, dot/trpl04-01.dot
into an svg
, run:
$ dot dot/trpl04-01.dot -Tsvg > src/img/trpl04-01.svg
In the generated SVG, remove the width and the height attributes from the svg
element and set the viewBox
attribute to 0.00 0.00 1000.00 1000.00
or other
values that don't cut off the image.
To scan source files for spelling errors, you can use the spellcheck.sh
script. It needs a dictionary of valid words, which is provided in
dictionary.txt
. If the script produces a false positive (say, you used word
BTreeMap
which the script considers invalid), you need to add this word to
dictionary.txt
(keep the sorted order for consistency).