From 5db94df0cd1e2a2e8eed4d6bfb6a45c46494722c Mon Sep 17 00:00:00 2001 From: Osnat Katz Moon <137817983+astrosnat@users.noreply.github.com> Date: Sat, 5 Oct 2024 22:16:42 +0700 Subject: [PATCH] Updating documentation (#362) * Update README.md Rewrote README to look more sales-friendly and less plain * Update CONTRIBUTING.md Added instructions for how to name a branch properly and added links to our Issues tab and Code of Conduct --- CONTRIBUTING.md | 5 +++-- README.md | 55 ++++++++++++++++++++++++++++--------------------- 2 files changed, 34 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 296351ff..6bf68061 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,7 @@ We welcome contributions from the community and are pleased that you're interest 3. **Create a Branch** - Create a new branch in your local repository before starting your work. - Use a clear branch name that describes the intent of your work, such as `feature/add-login` or `fix/header-bug`. + - Make sure your branch name starts with `feature`, `fix`, or `refactor`. 4. **Commit Your Changes** - Keep your commits as atomic as possible, each addressing a single concern. @@ -27,7 +28,7 @@ We welcome contributions from the community and are pleased that you're interest ## Reporting Issues -If you find a bug or have a feature request, please use the GitHub Issues tab to report them. Before creating a new issue, check to ensure the issue hasn't already been reported. When filing an issue, please include: +If you find a bug or have a feature request, please use the [GitHub Issues](https://github.com/openpredictionmarkets/socialpredict/issues) tab to report them. Before creating a new issue, check to ensure the issue hasn't already been reported. When filing an issue, please include: - A clear title and description. - As much relevant information as possible. @@ -35,7 +36,7 @@ If you find a bug or have a feature request, please use the GitHub Issues tab to ## Conduct -We are committed to providing a welcoming and inspiring community for all. Please take a moment to read our Code of Conduct before participating. +We are committed to providing a welcoming and inspiring community for all. Please take a moment to read our [Code of Conduct](https://github.com/openpredictionmarkets/socialpredict/blob/main/CODE_OF_CONDUCT.md) before participating. ## Questions? diff --git a/README.md b/README.md index ed494856..7a34588c 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,49 @@ -## Staging +# About SocialPredict +## Free Forecasting for Everyone, Everywhere -Check out our staging instance at [BrierFoxForecast](https://brierfoxforecast.com/) to see what the latest deployed version of master looks like. May be down if we are testing something. +We empower people and organizations to harness the **wisdom of crowds** and **make better decisions** with free, open-source forecasting software. -## README/ Contents +![Screenshot 2024-10-05 154211](https://github.com/user-attachments/assets/13f616f9-af04-47fc-a839-b24f82a419a8) -- [Info on Local Setup](/README/LOCAL_SETUP.md) -- [Info on Market Mathematics](/README/MATH/README-MATH.md) -- [Info on How Economics Can Be Customized](/README/README-CONFIG.md) -- [Info on Development Conventions](/README/README-CONVENTIONS.md) -- [Info on Feature Roadmap](/README/PROJECT_MANAGEMENT/README-ROADMAP.md) +No questions are too small (or too big) for our prediction market software. Set up your own instance and start forecasting anything from your next big event to next year's hottest tech breakthroughs. -# About SocialPredict +## Staging -## Empowering Communities with Domain-Specific Insights +Check out our staging instance at [BrierFoxForecast](https://brierfoxforecast.com/) to see what our software looks like in action. May be down if we are testing something. -Have you heard of Prediction Markets? +## Getting Started -- Prediction Markets, unlike polls, incentivize accuracy. Participants take a stake in what they think is correct, promoting rigorous research and reducing bias. +### Setting up a Local Instance -### Efficiency through Community Engagement +- [Info on Local Setup](/README/LOCAL_SETUP.md) +- [Info on How Economics Can Be Customized](/README/README-CONFIG.md) -SocialPredict is Open Source Software Which: +### Deploying to the Web -- Embraces the open-source ethos, making our platform free for anyone to deploy under the MIT License. +- [How to Set Up Your Own Website](/README/STAGE_SETUP.md) -### Domain-Specific Prediction Markets +### How Do Prediction Markets Work? -Imagine a prediction market platform tailored to specific interests, for example, photography and cameras: +Here's a quick primer about how (and why) [prediction markets work](/README/MATH/README-MATH.md). Want more info? We maintain a list of resources where you can see research on [prediction markets in action](https://github.com/openpredictionmarkets/resources). -- An admin runs a photographers-and-industry-specialists-only prediction market platform. -- Discussions and bets on technology predictions, specific to photography and adjacent technology. +## Contributing -### Community Empowering Mission +We welcome and appreciate every contribution. Get started by reading our [guide](https://github.com/openpredictionmarkets/socialpredict/blob/main/CONTRIBUTING.md) and make sure to follow our [Code of Conduct](https://github.com/openpredictionmarkets/socialpredict/blob/main/CODE_OF_CONDUCT.md). -We strive to: +### Where to Next? -- Empower communities to predict outcomes efficiently. -- Foster a deeper understanding of chosen domains. -- Facilitate the exchange of valuable insights. +- Brush up on our [Development Conventions](/README/README-CONVENTIONS.md) +- Check out our [ongoing Projects](https://github.com/openpredictionmarkets/socialpredict/projects?query=is%3Aopen) +- Look at our [Issues](https://github.com/openpredictionmarkets/socialpredict/issues) +- Have your say on [GitHub Discussions](https://github.com/orgs/openpredictionmarkets/discussions) ### Join us in shaping the future of prediction markets by building connections and expertise within your community! + +## Stargazers over time +[![Stargazers over time](https://starchart.cc/openpredictionmarkets/socialpredict.svg?variant=adaptive)](https://starchart.cc/openpredictionmarkets/socialpredict) + +## Licensing + +SocialPredict is available under the [MIT License](https://github.com/openpredictionmarkets/socialpredict/blob/main/LICENSE). + +