ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor formatting fixes

client-spec/clarity
Waldir Pimenta 2020-05-11 00:27:09 +01:00 committed by Zlatan Vasović
parent 37634b36f7
commit 75b9a1168c
4 changed files with 24 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CLIENT-SPECIFICATION.md
View File

@ -17,7 +17,8 @@ tldr-pages consists of multiple _pages_ - each of which describes a specific com
### Platform ### Platform
Pages are grouped by platform. A platform is an operating system. For example, `windows`, `linux`, `osx`. The special platform `common` contains pages for commands that work identically across more than 1 platform. Pages are grouped by platform, i.e. operating systems — for example, `windows`, `linux`, `osx`.
The special platform `common` contains pages for commands that work identically across more than one platform.
If a page is common across multiple platforms, but slightly differently on a given platform, then the page is still stored in `common`, but a copy tailored for the differing platform is placed in that platform's specific folder. If a page is common across multiple platforms, but slightly differently on a given platform, then the page is still stored in `common`, but a copy tailored for the differing platform is placed in that platform's specific folder.
@ -136,7 +137,9 @@ After transparently replacing spaces (` `) with dashes (`-`), clients have sever
### Platform ### Platform
Clients MUST default to displaying tldr-page from the platform upon which the client is running. For example, a client running on _Windows 10_ will default to displaying pages from the `windows` platform. Clients MAY provide a user-configurable option to override this behaviour, however. Clients MUST default to displaying the page associated with the platform on which the client is running.
For example, a client running on _Windows 10_ will default to displaying pages from the `windows` platform.
Clients MAY provide a user-configurable option to override this behaviour, however.
If a page is not available for the host platform, clients MUST fallback to the special `common` platform. If a page is not available for the host platform, clients MUST fallback to the special `common` platform.

31
LICENSE.md
View File

@ -1,6 +1,9 @@
Copyright © 2014—present the [tldr-pages team](https://github.com/orgs/tldr-pages/people) and [contributors](https://github.com/tldr-pages/tldr/graphs/contributors). Copyright © 2014—present the [tldr-pages team](https://github.com/orgs/tldr-pages/people)
and [contributors](https://github.com/tldr-pages/tldr/graphs/contributors).
### This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/). **This work is licensed under the
[Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/)
(CC-BY).**
---- ----
@ -10,19 +13,19 @@ are licensed under the MIT license:
> **The MIT License** > **The MIT License**
> >
> Permission is hereby granted, free of charge, to any person obtaining a copy > Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal > of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights > in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is > copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions: > furnished to do so, subject to the following conditions:
> >
> The above copyright notice and this permission notice shall be included in > The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software. > all copies or substantial portions of the Software.
> >
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. > THE SOFTWARE.

2
README.md
View File

@ -72,7 +72,7 @@ You can access these pages on your computer using one of the following clients:
- [Dash docset](https://github.com/Moddus/tldr-python-dash-docset): - [Dash docset](https://github.com/Moddus/tldr-python-dash-docset):
Open `Preferences` > `Downloads` > `User Contributed` and find `tldr pages` in the list Open `Preferences` > `Downloads` > `User Contributed` and find `tldr pages` in the list
- Docker images: - Docker images:
- [tldr-docker](https://github.com/nutellinoit/tldr-docker)- Run the `tldr` command via a docker container: `alias tldr='docker run --rm -it -v ~/.tldr/:/root/.tldr/ nutellinoit/tldr'` - [tldr-docker](https://github.com/nutellinoit/tldr-docker) - Run the `tldr` command via a docker container: `alias tldr='docker run --rm -it -v ~/.tldr/:/root/.tldr/ nutellinoit/tldr'`
- Elixir clients: - Elixir clients:
- [ExTldr](https://github.com/ivanhercaz/extldr). - [ExTldr](https://github.com/ivanhercaz/extldr).
- [TLDR Elixir Client](https://github.com/edgurgel/tldr_elixir_client) - [TLDR Elixir Client](https://github.com/edgurgel/tldr_elixir_client)