Add README-CN

.github/workflows/gh-pages.yml

@@ -22,13 +22,6 @@ jobs:
         run: |
           bundle exec rake book:all
 
-      - name: Copy
-        run: |
-          mkdir -p public
-          mv README.html index.html
-          cp *.html public
-          cp *.pdf public
-
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:

.github/workflows/preview.yml

@@ -25,13 +25,6 @@ jobs:
         run: |
           bundle exec rake book:all
 
-      - name: Copy
-        run: |
-          mkdir -p public
-          mv README.html index.html
-          cp *.html public
-          cp *.pdf public
-
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:

.gitignore

@@ -2,10 +2,5 @@
 .bundle/
 Gemfile.lock
 
-# Generated by asciidoctor
-*.html
-# Docinfo files
-!themes/*.html
-
-# Generated by asciidoctor-pdf
-*.pdf
+# Generated by asciidoctor and asciidoctor-pdf
+public/

README.adoc

@@ -1,61 +1,52 @@
 = LoongArch Documentation
 Loongson Technology Corporation Limited
-:docinfodir: themes
-:docinfo: shared
-:doctype: book
-:toc: left
+
+* https://loongson.github.io/LoongArch-Documentation/README-EN.html[English]
+* https://loongson.github.io/LoongArch-Documentation/README-CN.html[中文]
 
 == Introduction
 
-This is the translation of LoongArch documentation.
+The official documentation for LoongArch.
 
 * You can find documents online https://loongson.github.io/LoongArch-Documentation[here].
 
-* You can find all historical versions here https://github.com/loongson/LoongArch-Documentation/releases[here].
+* You can find all historical versions https://github.com/loongson/LoongArch-Documentation/releases[here].
 
-The HTML versions are more readable than the PDF versions, not only because there exists tables of excessive length, but also because the theme of html versions is easier to customize.
+The HTML versions are more readable than the PDF versions, not only because there exists tables of excessive length, but also because the theme of HTML versions is easier to customize.
 To make it easier to download, each HTML page contains embedded CSS and images.
 
 == Documents
 
 * LoongArch Reference Manual - Volume 1: Basic Architecture: This manual describes the basic part of the LoongArch architecture.
-** link:LoongArch-Vol1-EN.html[HTML version].
-** link:LoongArch-Vol1-EN.pdf[PDF version].
+** https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol1-EN.html[HTML version].
+** https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol1-EN.pdf[PDF version].
 ** https://github.com/loongson/LoongArch-Documentation/releases/latest/download/LoongArch-Vol1-v1.00-CN.pdf[Original document].
 
 * LoongArch Reference Manual - Volume 2: Vector Extensions: This manual describes the vector extensions (SIMD and Advanced SIMD Extensions) of the LoongArch architecture.
-** link:LoongArch-Vol2-EN.html[HTML version].
-** link:LoongArch-Vol2-EN.pdf[PDF version].
+** https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol2-EN.html[HTML version].
+** https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol2-EN.pdf[PDF version].
 ** https://github.com/loongson/LoongArch-Documentation/releases/latest/download/LoongArch-Vol2-v1.00-CN.pdf[Original document].
 
 * LoongArch Reference Manual - Volume 3: Virtualization and Binary Translation Extensions: This manual describes the virtualization and binary translation extensions of the LoongArch architecture.
-** link:LoongArch-Vol3-EN.html[HTML version].
-** link:LoongArch-Vol3-EN.pdf[PDF version].
+** https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol3-EN.html[HTML version].
+** https://loongson.github.io/LoongArch-Documentation/LoongArch-Vol3-EN.pdf[PDF version].
 ** https://github.com/loongson/LoongArch-Documentation/releases/latest/download/LoongArch-Vol3-v1.00-CN.pdf[Original document].
 
 * Loongson 3A5000/3B5000 Registers Technical Reference Manual - Multicore Processor Architecture, Register Descriptions and System Software Programming Guide: This manual introduces the Loongson 3A5000/3B5000 multicore processor architecture and register descriptions.
-** link:Loongson-3A5000-usermanual-EN.html[HTML version].
-** link:Loongson-3A5000-usermanual-EN.pdf[PDF version].
+** https://loongson.github.io/LoongArch-Documentation/Loongson-3A5000-usermanual-EN.html[HTML version].
+** https://loongson.github.io/LoongArch-Documentation/Loongson-3A5000-usermanual-EN.pdf[PDF version].
 ** https://github.com/loongson/LoongArch-Documentation/releases/latest/download/Loongson-3A5000-usermanual-v1.02-CN.pdf[Original document].
 
 * Loongson 7A1000 Bridge User Manual: This manual describes the overall bridge architecture, clock structure, address space, configuration registers, and individual functional interfaces, primarily for BIOS and kernel developers.
-** link:Loongson-7A1000-usermanual-EN.html[HTML version].
-** link:Loongson-7A1000-usermanual-EN.pdf[PDF version].
+** https://loongson.github.io/LoongArch-Documentation/Loongson-7A1000-usermanual-EN.html[HTML version].
+** https://loongson.github.io/LoongArch-Documentation/Loongson-7A1000-usermanual-EN.pdf[PDF version].
 ** https://github.com/loongson/LoongArch-Documentation/releases/latest/download/Loongson-7A1000-usermanual-v2.00-CN.pdf[Original document].
 
 * LoongArch ELF ABI: This manual describes the LoongArch ELF ABI.
-** link:LoongArch-ELF-ABI-EN.html[HTML version].
-** link:LoongArch-ELF-ABI-EN.pdf[PDF version].
+** https://loongson.github.io/LoongArch-Documentation/LoongArch-ELF-ABI-EN.html[HTML version].
+** https://loongson.github.io/LoongArch-Documentation/LoongArch-ELF-ABI-EN.pdf[PDF version].
 ** https://github.com/loongson/LoongArch-Documentation/releases/latest/download/LoongArch-ELF-ABI-v1.00-CN.pdf[Original document].
 
-== Translator`'s Note
-
-These documents were translated by Yanteng Si and Feiyang Chen.
-
-Due to the limited knowledge of the translators, there are some inevitable errors and omissions existing in this document, please feel free to correct.
-
-_P.S._ Since the academic level of the original authors is extraordinary high, words and phrases in the original documents are so profound that the translators with limited knowledge could not express them accurately even if they tried their best.
-
 == Getting Start
 
 We *strongly recommend* that you develop on Linux/UNIX or macOS.
@@ -154,12 +145,12 @@ So you should not modify this branch directly.
 
 * This project was inspired by https://github.com/progit/progit2[Pro Git, Second Edition].
 
-* This project use https://asciidoctor.org[Asciidoctor] to generate HTML, and use https://github.com/asciidoctor/asciidoctor-pdf[Asciidoctor PDF] to generate documents.
+* This project use https://asciidoctor.org[Asciidoctor] to generate HTML documents, and use https://github.com/asciidoctor/asciidoctor-pdf[Asciidoctor PDF] to generate PDF documents.
 
 * See https://docs.asciidoctor.org/asciidoc/latest[AsciiDoc Language Documentation] for AsciiDoc syntax.
 
 * See https://github.com/darshandsoni/asciidoctor-skins[
-asciidoctor-skins] for CSS stylesheets for asciidoctor.
+asciidoctor-skins] for CSS stylesheets for Asciidoctor.
 See https://github.com/asciidoctor/asciidoctor-pdf/blob/main/docs/theming-guide.adoc[Asciidoctor PDF Theming Guide] for the style of a PDF file generated by Asciidoctor PDF from AsciiDoc.
 
 == Troubleshooting
@@ -169,7 +160,7 @@ See https://github.com/asciidoctor/asciidoctor-pdf/blob/main/docs/theming-guide.
 Some of the file paths are so long that they exceed the 260-character limit of the Windows API, which can cause some strange problems.
 
 In Windows 10 version 1607 and later, these problems can be solved.
-If you are using an earlier version, or if you don`'t want to do some extra operations, you might consider using docker, refer to <<Developing on Docker>> for more details.
+If you are using an earlier version, or if you don`'t want to do some extra operations, you might consider using Docker, refer to <<Developing on Docker>> for more details.
 
 . https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation#enable-long-paths-in-windows-10-version-1607-and-later[Enable] long paths.
 
@@ -189,17 +180,14 @@ You may find the official https://hub.docker.com/r/asciidoctor/docker-asciidocto
 
 == License
 
-include::LICENSE[]
+link:LICENSE[License]
 
 == Contributors
 
 Since the release of the project, we have gotten several errata and content changes donated.
 Here are all the people who have contributed to https://github.com/loongson/LoongArch-Documentation[LoongArch Documentation] as an open source project.
-Thank you everyone for helping make this a better book for everyone.
+Thank you everyone for helping make this project better.
 
-The contributors are listed in alphabetical order.
+The contributors are listed in alphabetical order:
 
-[source]
-----
-include::contributors.txt[]
-----
+link:contributors.txt[Contributors]

Rakefile

@@ -1,5 +1,5 @@
 namespace :book do
-    books = FileList['*.adoc']
+    books = FileList['docs/*.adoc']
 
     desc 'build basic book formats'
     task :all =>[:html, :pdf]
@@ -8,22 +8,20 @@ namespace :book do
     task :html, [:arg] do |t, args|
         args.with_defaults(:arg => books)
         puts 'Converting to HTML...'
-        `bundle exec asciidoctor -v -b html5 -a stylesheet=themes/html.css -a data-uri #{args[:arg]}`
+        `bundle exec asciidoctor -v -b html5 -a stylesheet=../themes/html.css -a data-uri -D public #{args[:arg]}`
         puts ' -- HTML conversion done!'
     end
 
     desc 'build PDF format'
     task :pdf, [:arg] do |t, args|
         args.with_defaults(:arg => books)
         puts 'Converting to PDF... (this will take a while)'
-        `bundle exec asciidoctor-pdf -v -a pdf-theme=themes/pdf.yml -a pdf-fontsdir="fonts;GEM_FONTS_DIR" #{args[:arg]}`
+        `bundle exec asciidoctor-pdf -v -a pdf-theme=themes/pdf.yml -a pdf-fontsdir="fonts;GEM_FONTS_DIR" -D public #{args[:arg]}`
         puts ' -- PDF conversion done!'
     end
 
     desc 'Clean all generated files'
     task :clean do |t|
-        FileList['*.html', '*.pdf'].each do |file|
-            rm file
-        end
+        rm_rf 'public'
     end
 end

LoongArch-ELF-ABI-EN.adoc → docs/LoongArch-ELF-ABI-EN.adoc

@@ -1,7 +1,7 @@
 = LoongArch ELF ABI specification
 Loongson Technology Corporation Limited
 v1.00
-:docinfodir: themes
+:docinfodir: ../themes
 :docinfo: shared
 :doctype: book
 :toc: left