forked from openpredictionmarkets/socialpredict
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating documentation (openpredictionmarkets#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
- Loading branch information
Showing
2 changed files
with
34 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). | ||
|
||