]> git.lizzy.rs Git - rust.git/blobdiff - src/doc/README.md
auto merge of #17432 : nick29581/rust/contrib, r=brson
[rust.git] / src / doc / README.md
index 9135650c31becc5a7d7a94eedd994248ae3330a2..933c1b5a6cd85823d05920bf1034dedb8b9d8d78 100644 (file)
@@ -4,10 +4,6 @@
 document converter, is required to generate docs as HTML from Rust's
 source code.
 
-[Node.js](http://nodejs.org/) is also required for generating HTML from
-the Markdown docs (reference manual, tutorials, etc.) distributed with
-this git repository.
-
 [po4a](http://po4a.alioth.debian.org/) is required for generating translated
 docs from the master (English) docs.
 
@@ -23,15 +19,15 @@ for the 'std' and 'extra' libraries.
 To generate HTML documentation from one source file/crate, do something like:
 
 ~~~~
-rustdoc --output-dir html-doc/ --output-format html ../src/libstd/path.rs
+rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs
 ~~~~
 
 (This, of course, requires a working build of the `rustdoc` tool.)
 
 # Additional notes
 
-To generate an HTML version of a doc from Markdown without having Node.js
-installed, you can do something like:
+To generate an HTML version of a doc from Markdown manually, you can do
+something like:
 
 ~~~~
 pandoc --from=markdown --to=html5 --number-sections -o rust.html rust.md
@@ -57,12 +53,12 @@ To generate .pot and .po files, do something like:
 ~~~~
 po4a --copyright-holder="The Rust Project Developers" \
     --package-name="Rust" \
-    --package-version="0.10-pre" \
+    --package-version="0.11.0" \
     -M UTF-8 -L UTF-8 \
-    po4a.conf
+    src/doc/po4a.conf
 ~~~~
 
-(the version number must be changed if it is not 0.10-pre now.)
+(the version number must be changed if it is not 0.11.0 now.)
 
 Now you can translate documents with .po files, commonly used with gettext. If
 you are not familiar with gettext-based translation, please read the online
@@ -73,7 +69,7 @@ When you want to make a commit, do the command below before staging your
 change:
 
 ~~~~
-for f in doc/po/**/*.po; do
+for f in src/doc/po/**/*.po; do
     msgattrib --translated $f -o $f.strip
     if [ -e $f.strip ]; then
        mv $f.strip $f