awesomewm-mirrors
/
awesome-www
mirror of https://github.com/awesomeWM/awesome-www.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README.md: Try to limit lines to 80 characters 

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2017-10-31 14:12:25 +01:00
parent 5ecd3e35f2
commit e8ff8055ba
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -31,32 +31,41 @@ To contribute with Screenshots:
1. Add a new `<figure>` tag in the bottom of *screenshots.mdwn*,
1. Inside the new tag, add the screenshots with a `<img>` tag and use the `<figcaption>` to add caption to the image, explaining what is being used on the screenshot.
1. Inside the new tag, add the screenshots with a `<img>` tag and use the
`<figcaption>` to add caption to the image, explaining what is being used on
the screenshot.
## Contributing to Recipes Section
Fork this repository and create a new branch with a name relevant to the information you will be adding to the site.
If you have doubts in how to Fork and Branch, take a look in this cheat-sheet [here](https://www.git-tower.com/blog/git-cheat-sheet/)
Fork this repository and create a new branch with a name relevant to the
information you will be adding to the site. If you have doubts in how to Fork
and Branch, take a look in this cheat-sheet
[here](https://www.git-tower.com/blog/git-cheat-sheet/)
The process of editing files can be done inside GitHub's interface, more information [here](https://help.github.com/articles/github-flow/)
The process of editing files can be done inside GitHub's interface, more
information [here](https://help.github.com/articles/github-flow/)
### With external Link
Create a new link in markdown format `[Link Name](Real Link)` in the appropriate section in `recipes.mdwn` file.
Create a new link in markdown format `[Link Name](Real Link)` in the appropriate
section in `recipes.mdwn` file.
### With internal Link (host in awesome site)
1. Create a new page with your tutorial/setup/widget/snippet in Markdown, with a relevant name, under the `recipes` folder.
1. Create a new page with your tutorial/setup/widget/snippet in Markdown, with a
relevant name, under the `recipes` folder.
- Example `recipes/xrandr-tutorial.mdmw`
1. Link your page to the right section in the `recipes.mdwn` page with Markdown syntax.
1. Link your page to the right section in the `recipes.mdwn` page with Markdown
syntax.
- Example `[XrandR Tutorial](../recipes/xrandr-tutorial.html)`
### Seeing results and pulling your changes
1. Build the site as explained in the Hacking section in this same page to check how your changes will look like.
1. Build the site as explained in the Hacking section in this same page to check
how your changes will look like.
1. If everything is right and looks good, you're ready do make a Pull Request.
@ -64,7 +73,8 @@ Create a new link in markdown format `[Link Name](Real Link)` in the appropriate
The master branch gets built by
[Travis CI](https://travis-ci.org/awesomeWM/awesome-www/), and is then published
through [Github's Organization Pages](https://github.com/awesomeWM/awesomeWM.github.io).
through
[Github's Organization Pages](https://github.com/awesomeWM/awesomeWM.github.io).
## Other resources