aliu139 / forkme

Making README generation simple again, one project at a time!

ForkMe

by Austin Liu and Jared Wong

''Perhaps if we wrote programs from childhood on, as adults we'd be able to read them.'' - Alan J. Perlis

Introduction

In a perfect world, every repository on GitHub would have a clear README, capable of letting visitors know about the purpose, usages, and history behind a project. However, writing a consise yet comprehensive README is an art that takes time and thought. ForkMe is our attempt at disrupting the current ecosystem of READMEs, by automating the process! Even if you aren't familiar with the newest startup jargon, let our product revolutionize the way that you document your product.

How to Run

Just open it up in a browser, and click through the expeience!

• If you want to add custom text, click on the wrench and type in your desired text
• If you want to let us do the magic for you, just click on the wand!

Built With

• VueJS
• Bootstrap
• Python
• • NLTK
• Data from various READMEs on GitHub
• LoremFlickr

Inspired By

Jared Wong's original Pitbull Generator

Data Credits

Code snippets courtesy of FizzBuzz Enterprise Edition

README data sources include the following:

• aimeos TYPO3
• AngularJS
• Enterprise FizzBuzz
• dotfiles
• Github Changelog Generator
• Node.JS Chat
• React - Basic Theoretical Concepts
• re-frame
• University of Washington README examples
• Scrum Crash Course

Thanks

If you've read up to this point, you deserve to know that typing the name of a certain president-elect may affect the dictionaries being used...

• Trump Data