Skip to content

Commit 09b3d89

Browse files
author
smellai
committed
minor fix readme
1 parent e00bb78 commit 09b3d89

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.adoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
= Reference-en
2-
Reference-en is the repo for the Language Reference documentation of the Arduino syntax in **English**.
1+
= Reference-fr
2+
3+
Reference-fr is the repo for the Language Reference documentation of the Arduino syntax in **French**.
34
All the Reference terms files are in AsciiDoc format.
45

56
Thank you for taking the time to contribute to Arduino content, this is really helpful to the whole Arduino Community.
67

78
== Content Creation and Editing
89
If you want to contribute new content, create a new file (with any text or code editor) and save it as .adoc.
910
Do not use parenthesis or any special character in the file name.
10-
In https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc[`reference-en/AsciiDoc_sample/AsciiDoc_Dictionary`] you will find an overview on the AsciiDoc syntax. This includes Titles, Text, Links, Images, Tables, Code and various embeds (video, slideshow, audio and code). You can see it rendered https://reference.arduino.cc/reference/en/asciidoc_sample/asciidoc_dictionary/asciidoc_template-dictionary/[here].
11+
In https://raw.githubusercontent.com/arduino/reference-fr/master/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc[`reference-fr/AsciiDoc_sample/AsciiDoc_Dictionary`] you will find an overview on the AsciiDoc syntax. This includes Titles, Text, Links, Images, Tables, Code and various embeds (video, slideshow, audio and code). You can see it rendered https://reference.arduino.cc/reference/en/asciidoc_sample/asciidoc_dictionary/asciidoc_template-dictionary/[here].
1112

12-
If you want to contribute to the Language Reference or edit existing content, you can find two templates in reference-en/AsciiDoc_sample/Reference_Terms:
13+
If you want to contribute to the Language Reference or edit existing content, you can find two templates in reference-fr/AsciiDoc_sample/Reference_Terms:
1314

14-
* Use https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc[`AsciiDoc_Template-Single_Entity.adoc`] (rendered https://reference.arduino.cc/reference/en/asciidoc_sample/reference_terms/asciidoc_template-single_entity/[here]) for terms such as link:http://arduino.cc/en/Reference/AnalogWrite[analogWrite].
15-
* Use https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc[`AsciiDoc_Template-Parent_Of_Entities.adoc`] (rendered https://reference.arduino.cc/reference/en/asciidoc_sample/reference_terms/asciidoc_template-parent_of_entities/[here]) for groups of functions such as link:http://arduino.cc/en/Reference/Serial[Serial].
15+
* Use https://raw.githubusercontent.com/arduino/reference-fr/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc[`AsciiDoc_Template-Single_Entity.adoc`] (rendered https://reference.arduino.cc/reference/en/asciidoc_sample/reference_terms/asciidoc_template-single_entity/[here]) for terms such as link:http://arduino.cc/en/Reference/AnalogWrite[analogWrite].
16+
* Use https://raw.githubusercontent.com/arduino/reference-fr/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc[`AsciiDoc_Template-Parent_Of_Entities.adoc`] (rendered https://reference.arduino.cc/reference/en/asciidoc_sample/reference_terms/asciidoc_template-parent_of_entities/[here]) for groups of functions such as link:http://arduino.cc/en/Reference/Serial[Serial].
1617

1718
Please note that every Reference file should include as least a Description, some Example Code, and links to other relevant infos (See Also section).
1819

@@ -36,7 +37,7 @@ Please note that your contribution to the Arduino Reference is licensed under a
3637
=== Folder Structure
3738
[source]
3839
----
39-
reference-en
40+
reference-fr
4041
├─ AsciiDoc_sample
4142
│   ├── AsciiDoc_Dictionary
4243
│   │   ├── AsciiDoc_Template-Dictionary.adoc

0 commit comments

Comments
 (0)