This is an automated email from the ASF dual-hosted git repository.
andreww pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
The following commit(s) were added to refs/heads/master by this push:
new ef18c04 Update README.md
ef18c04 is described below
commit ef18c04e77127206315f0dae84317ee48fab2b54
Author: Andrew Wetmore <[email protected]>
AuthorDate: Fri May 24 15:38:59 2019 -0300
Update README.md
Clarified naming conventions for file names.
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index f73d758..21ab80e 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ Use HTML comments at the top of the document for any
explanatory notes for the d
## File names and titles
- File names do not have to be the same as the titles that display at the top
of the file.
-- For file names, use all lower-case, join words with hyphens, not _ and not
```%20``` statements, and add the markdown specification. The file name should
be "important-thing.md", not "Another%20Important%20Thing.md",
"AnotherImportantThing.md", or "Another_important_thing.md". This is important
for SEO, human readability, and readability by assistive devices.
+- For file names, use all lower-case, join words with - and not _ or
```%20``` statements, and add the markdown specification. The file name should
be "another=important-thing.md", not "Another%20Important%20Thing.md",
"AnotherImportantThing.md", or "Another_important_thing.md". This is important
for SEO, human readability, and readability by assistive devices.
- File titles should be in sentence case: "Another important Royale thing",
not "Another Important Royale Thing". The point here is that the more capitals
involved, the harder it is to read the statement.
## Documentation conventions
