README
¶
Popper
Popper is a convention and CLI tool for generating reproducible papers. This repository contains:
- A CLI tool to help bootstrap research articles that adhere to the convention.
- Documentation about the convention.
- Experiment re-usable templates that can be retrieved using the CLI tool (or by cloning this repo).
Installation
To get started with the CLI tool, download Popper from popper/releases. Note that we have only binaries for macOS and Linux. Once downloaded, uncompress and place the binary in a folder that is included in your $PATH (e.g. /usr/local/bin). For Windows, we recommend using Popper with the Windows Subsystem for Linux.
To get an overview and list of commands check out the command line help:
popper help
For a quickstart guide on how to use the CLI, look here.
Contributing
Anyone is welcome to contribute to Popper! To get started, take a look at our roadmap and CONTRIBUTING.md, then dive in with our list of good first issues.
Participation Guidelines
Popper adheres to the code of conduct posted in this repository. By participating or contributing to Popper, you're expected to uphold this code. If you encounter unacceptable behavior, please immediately email us.
Directories