Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Remove Hacktoberfest section and information about the CLI tool
  • Loading branch information
Sina Hamedian committed Nov 3, 2017
1 parent 4d62ea0 commit 1d61f6a
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

[![Join the chat at https://gitter.im/systemslab/popper](https://badges.gitter.im/systemslab/popper.svg)](https://gitter.im/falsifiable-us/popper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Popper is a convention for generating reproducible papers. We're working with scientists in genomics, weather prediction, playable media, distributed systems (and adding more domains) to have them use DevOps tools and follow software engineering best-practices when they implement experiments associated to academic articles. Our goal is to lower the barriers for collaboration and the sharing of knowledge.

## Getting Started

This repository contains:
Popper is a convention and CLI tool for generating reproducible papers. This repository contains:

* A [CLI tool](popper/) to help bootstrap research articles that
adhere to the convention.
Expand All @@ -15,14 +11,21 @@ This repository contains:
* [Experiment re-usable templates](templates/) that can be retrieved using the
CLI tool (or by cloning this repo).

## Contributing
## Installation

Anyone is welcome to contribute to Popper! To get started, take a look at our [roadmap](https://github.com/systemslab/popper/issues/1) and [CONTRIBUTING.md](CONTRIBUTING.md).
To get started with the CLI tool, download Popper from [popper/releases](https://github.com/systemslab/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/bin`). For Windows, we recommend using Popper with the [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/install-win10).

## Participation Guidelines
To get an overview and list of commands check out the command line
help:

Popper adheres to our code of conduct, [posted in this repository](CODE_OF_CONDUCT.md). By participating or contributing to Popper, you're expected to uphold this code. If you encounter unacceptable behavior, please immediately [email us](mailto:ivo@cs.ucsc.edu).
```bash
popper help
```

## Hacktoberfest
## Contributing

Anyone is welcome to contribute to Popper! To get started, take a look at our [roadmap](https://github.com/systemslab/popper/issues/1) and [CONTRIBUTING.md](CONTRIBUTING.md), then dive in with our [list of good first issues](https://github.com/systemslab/popper/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3Ahacktoberfest).

## Participation Guidelines

Join us for [Hacktoberfest](https://hacktoberfest.digitalocean.com/) this month to collaborate on this project and have a chance to win a Hacktoberfest t-shirt!
Popper adheres to the code of conduct [posted in this repository](CODE_OF_CONDUCT.md). By participating or contributing to Popper, you're expected to uphold this code. If you encounter unacceptable behavior, please immediately [email us](mailto:ivo@cs.ucsc.edu).

0 comments on commit 1d61f6a

Please sign in to comment.