tttp / beautiful-foss

Beautiful FOSS is a repository boilerplate filled with best practices and guidelines for starting and scaling your next beautiful free and open-source software project.

Beautiful FOSS!

A Github repository template to make your repositories beautiful in minutes.

Key features • Get started • Frequently asked questions • Related • Credits • License

Key Features

1. Beautiful & easy-to-understand readme files:
   Tired of an ugly, hard to undestand readme file? Update your readme today with one of our easy to customize pre-made templates and never have someone pass up on your project again due to a poor-quality readme!
2. Landing page with optimized SEO:
   Every project needs a landing page with optimized SEO to be discoverable online. Without it, it's unlikely users will find your project on Google. Use one of our easy to customize templates and get on Google in minutes!
3. Opengraph images:
   Ever post about your project on Twitter, Facebook, Discord, etc. and notice it didn't have a fancy preview like other websites? We make it easy to build opengraph preview for every platform with included Figma templates - so you can get more share's instantly!
4. Self-promotion links:
   Every open-source project needs some spotlight, which is why we included a list of helpful & easy-to-post self-promotion links! Upload your project in minutes, build backlinks, and find new users across social media!

Get started

Getting started with Beautiful FOSS is quick and easy.

1. To begin, clone the project locally:

   git clone https://github.com/Neutron-Creative/Beautiful-FOSS.git && cd Beautiful-FOSS

2. Now, select copy your desired assets to your new project:
   

   For readme's, see /components/readme

   cp components/readme/readme-x.md

   For landing page's, see /components/landing-page

   cp components/landing-page/lp-x.html

   For Open Graph image's, see /components/open-graph

   cp components/open-graph/og-x.fig

3. Finally, replace the template content with your project information: For text files (such as the readme & landing pages), you should find content surrounded brackets similar to handlebars syntax. You can find & replace this infomration with regex, or simply replace it by hand if you're unfamiliar. For non-text files (such as the Figma Open Graph images), simply open those files and manually replace the text included with your new content.

Notice: An auto asset-generating script is planned & on the roadmap, however we currently lack resources & contributors to help. If this is something that would help you, please consider making a pull-request or donating to support project development!

Frequently Asked Questions

Coming soon

Related

Beautiful FOSS is Neutron Creative product, created and maintained free of charge in the mission of open-source. To learn more about our mission, visit our website at neutroncreative.com

Credits

Beautiful FOSS was built by the following individuals.

• Jim Bisenius (@jim_bisenius)

Currently, Beautiful FOSS lacks contributors outside its founders at Neutron Creative, but, you can help.

Visit the issues page today and create your first pull request to get featured here!

License

A boilerplate repository with filled with best-practices and guidelines for starting & scaling your next beautiful free and open-source software project.

Copyright (C) 2020 Neutron Creative Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.