Harmonize project name (lowercase tldr, no semicolon, hyphen-separated)
This commit is contained in:

committed by
Zlatan Vasović

parent
a5eca83cca
commit
37634b36f7
@@ -1,10 +1,10 @@
|
||||
Most people submit pull requests to the tldr project
|
||||
Most people submit pull requests to the tldr-pages project
|
||||
[using GitHub's web interface][pr-howto].
|
||||
|
||||
If you prefer, you can do most of the process using the command line instead.
|
||||
The overall process should look somewhat like this:
|
||||
|
||||
1. Fork the tldr repository on the GitHub web interface.
|
||||
1. Fork the tldr-pages/tldr repository on the GitHub web interface.
|
||||
|
||||
2. Clone your fork locally:
|
||||
`git clone https://github.com/{{your_username}}/tldr.git && cd tldr`
|
||||
|
@@ -41,7 +41,7 @@ as a guideline for current and future maintainers.
|
||||
Keep in mind that
|
||||
[every form of contribution](https://github.com/kentcdodds/all-contributors)
|
||||
(pull request, feature request, bug report, etc.)
|
||||
is a voluntary gift of time offered to the tldr project
|
||||
is a voluntary gift of time offered to the tldr-pages project
|
||||
by someone who cares about it,
|
||||
so make sure it's clear that that we don't take it for granted.
|
||||
|
||||
|
@@ -1,6 +1,6 @@
|
||||
# Style guide
|
||||
|
||||
This page lists specific formatting instructions for tldr pages.
|
||||
This page lists specific formatting instructions for `tldr` pages.
|
||||
|
||||
## Layout
|
||||
|
||||
@@ -34,7 +34,7 @@ tldrl -f {{page.md}}
|
||||
For other ways to use `tldrl`, such as linting an entire directory, check out (what else!)
|
||||
[`tldr tldrl`](https://github.com/tldr-pages/tldr/blob/master/pages/common/tldrl.md)
|
||||
|
||||
If you're using the Node.js client of `tldr`, you can preview a page locally using the `-f` flag (aka `--render`):
|
||||
If you're using the Node.js client of tldr-pages, you can preview a page locally using the `-f` flag (aka `--render`):
|
||||
|
||||
```
|
||||
tldr -f {{page.md}}
|
||||
|
Reference in New Issue
Block a user