Skip to content

Commit 6fd5f46

Browse files
committed
readme
1 parent 6666e32 commit 6fd5f46

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
# Directory of Resources for FOSS maintainers
22

3-
https://resources.opensourcelobby.org/ is a curated directory + compilation of valuable resources on the internet that can help maintainers to create, manage, and grow a FOSS project. This is a [opensourcelobby](https://opensourcelobby.org/) initiative.
3+
https://resources.opensourcelobby.org/ is a curated directory + compilation of valuable resources on the internet that can help maintainers create, manage, and grow FOSS projects. This is an [opensourcelobby](https://opensourcelobby.org/) project.
44

55
## Contributing
66

77
All resources are listed in the [data.yml](data.yml) file. To add a new resource or change something, submit a PR with a patch to it. The website will be updated automatically upon merge.
88

99
Ensure adding suitable `category` (eg. Funding, Security, Documentation) and `type` (eg. fund, worksheet, knowledge-base) tags to your entries.
1010

11-
1211
## Building locally
12+
1313
The website is a set of static HTML pages that are automatically generated from the Jinja template file `template.html`. The static assets are in the `static` directory.
1414

1515
1. Clone the repo.
1616
2. `pip install -r requirements.txt`
17-
<!-- 3. # `python build.py` to generate the static site into the `site` directory. -->
17+
3. `dirmaker --build`
18+
4. `cd site`
19+
5. `python3 -m http.server 8000` (to test locally)
1820

1921
## License
22+
2023
The repository, data, and the static site generated are licensed under the Creative Commons Attribution-ShareAlike License.
2124

2225
## Attributions
2326

24-
The directory is made using [Dirmaker](). Credit to [Jeswin Jose]() for logo design.
27+
This directory is made using [Dirmaker](https://github.com/knadh/dirmaker). Credit to [Jeswin Jose](https://www.linkedin.com/in/jeswinjosu/) for logo design.

0 commit comments

Comments
 (0)