Awesome-Mirrors/awesome-ipfs
1
0
Fork 0
mirror of https://github.com/ipfs/awesome-ipfs.git synced 2024-12-28 16:59:34 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #175 from Siderus/feature/as-a-user-I-want-to-know-how-to-build-the-readme-file

Browse Source 
Adds a simple text to explain how to build before PR.
This commit is contained in:
Lorenzo Setale 2018-07-31 17:19:40 +02:00 committed by GitHub
commit 2f92d58456
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -22,7 +22,7 @@ _This list is for projects, tools, or pretty much any things related to IPFS tha
## Contribute to this list!
Everyone is welcome to submit their new awesome-ipfs item. Check the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so.
Everyone is welcome to submit their new awesome-ipfs item. In order to add an element to this list, you need to modify the files in `/data` and then run a simple `make build` before publishing your pull request as the Readme and the website are automatically generated. Check the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so.
## Apps

4
scripts/readme-template.md
View File

@ -18,7 +18,9 @@ _This list is for projects, tools, or pretty much any things related to IPFS tha
## Contribute to this list!
Everyone is welcome to submit their new awesome-ipfs item. Check the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so.
Everyone is welcome to submit their new awesome-ipfs item. In order to add an element to this list, you need to modify the files in `/data` and then run a simple `make build` before publishing your pull request as the Readme and the website are automatically generated. Check the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so.
**NOTE**: If you want to edit the README file directly (not the items/links) you need to modify the [README template](https://github.com/ipfs/awesome-ipfs/blob/master/scripts/readme-template.md) instead and run `make build` again. Thank you!
#PLACEHOLDER_CATEGORIES#