Welcome to write-me’s documentation!¶
Write-me generates concise, effective, and specific READMEs based on your codebase.
Contents:
Introduction¶
Description¶
Write-me is a PyPI package that searches through a user’s codebase, and uses filepaths, docstrings, web framework specifications, installed requirements, and other user-added data to generate a README.md file.
This package was written as a project by students at Code Fellows, Seattle in December 2017.
Project Repository: write-me
Change Log¶
Write-me is currently on its first version: write-me-1.0. Future breaking and non-breaking changes in functionality will be documented here.
Installation¶
Prerequisites¶
To use write-me, you must have:
To ensure that you have these packages installed, execute the following on your commandline:
$ pip --version
and
$ python --version
The output of both should be something like ‘Python 3.6.3’. If running the which command returns nothing to the commandline, the package is not installed. In that case, download the packages using the instructions from the links above.
Installing write-me¶
Now that you have Python and pip installed, you can proceed to installing write-me! As write-me is a PyPI package, it is pip installable. On the commandline, execute the following:
$ pip install write-me
If the installation is a success, the package will collect and install, and will end with the line:
$ Successfully installed write-me-1.0