From d710797570f5c5263ecd616f73bbc1e0b6fa9ec8 Mon Sep 17 00:00:00 2001 From: Marcel Deglau Date: Thu, 23 Apr 2020 19:02:31 +0200 Subject: [PATCH 01/11] Update README.md --- README.md | 84 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 67 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index f478271..1c2fc45 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,67 @@ -# ac-nh-turnip-prices -[![discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/bRh74X8) - -Price calculator/predictor for Turnip prices -## Scope - -This tool is: -- A predictor for future prices that week -- Able to calculate probabilities for different futures -- Able to show data from a query string -- A single page web-based app - -This tool is not: -- A calculator for how much money you'll make -- A way to count your turnips -- A way to store multiple people's islands -- Something with a backend +

Turnip Prophet logo

+ +

+ + + + +

+ +# Animal Crossing: Turnip Prophet + +Turnip Prophet is a price calculator/price predictor for Animal Crossing turnip prices. + +### Support + +If you have any questions feel free to join our Discord server ([discord.gg/bRh74X8](https://discord.gg/bRh74X8)) to ask or [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues). + +Before opening a new issue, we would appreciate it if you would briefly use the search to avoid duplicate questions, because every duplicate question causes other functions to wait ;-) + +Please create issues in English language only. + +### Adding a new language + +Turnip Prophet is already available in some languages. If your local language is not listed you may go on to create a language file for it (requires basic git and development skills). + +For details don't hesitate to talk to us, e.g. using our Discord server. + +### What's about feature X? + +At first please have a look at our current project scope: + + + + + + + + + + + + + + +
Turnip Prophet is forTurnip Prophet is not for
+
    +
  • A predictor for future prices that week
    • +
  • Able to calculate probabilities for different futures
    • +
  • Able to show data from a query string
    • +
  • A single page web-based app
    • +
+ 		+
    +
  • A calculator for how much money you'll make
    • +
  • A way to count your turnips
    • +
  • A way to store multiple people's islands
    • +
  • Something with a backend
    • +
+
+ +If your idea, suggestment or improvement is anything out of the above named, feel free to [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues) or contribute by a [new pull request](https://github.com/mikebryant/ac-nh-turnip-prices/pulls). + +### Final statement + +A special thanks to all who [contribute](https://github.com/mikebryant/ac-nh-turnip-prices/graphs/contributors) to this project, helping improve it and spend their time. + +Stay awesome guys. \ No newline at end of file From 04188e52c902ba4f01ae83bb5644e4182079e83b Mon Sep 17 00:00:00 2001 From: Marcel Deglau Date: Thu, 23 Apr 2020 19:05:54 +0200 Subject: [PATCH 02/11] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1c2fc45..72668f2 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Turnip Prophet is a price calculator/price predictor for Animal Crossing turnip prices. -### Support +## Support If you have any questions feel free to join our Discord server ([discord.gg/bRh74X8](https://discord.gg/bRh74X8)) to ask or [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues). @@ -19,13 +19,13 @@ Before opening a new issue, we would appreciate it if you would briefly use the Please create issues in English language only. -### Adding a new language +## Adding a new language Turnip Prophet is already available in some languages. If your local language is not listed you may go on to create a language file for it (requires basic git and development skills). For details don't hesitate to talk to us, e.g. using our Discord server. -### What's about feature X? +## What's about feature X? At first please have a look at our current project scope: @@ -60,8 +60,8 @@ At first please have a look at our current project scope: If your idea, suggestment or improvement is anything out of the above named, feel free to [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues) or contribute by a [new pull request](https://github.com/mikebryant/ac-nh-turnip-prices/pulls). -### Final statement +## Final statement A special thanks to all who [contribute](https://github.com/mikebryant/ac-nh-turnip-prices/graphs/contributors) to this project, helping improve it and spend their time. -Stay awesome guys. \ No newline at end of file +Stay awesome guys. From fbc7959aa3413252d2ea859f8edbbd1796b12f97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 22:45:43 +0200 Subject: [PATCH 03/11] Add details on game --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 72668f2..daa14f2 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@

-# Animal Crossing: Turnip Prophet +# Animal Crossing New Horizons: Turnip Prophet Turnip Prophet is a price calculator/price predictor for Animal Crossing turnip prices. From 69d96532f35bf6f6b877772c8f967a76d349e55e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 22:55:50 +0200 Subject: [PATCH 04/11] Replace html with markdown in images --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index daa14f2..548d716 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,10 @@ -

Turnip Prophet logo

- -

- - - - -

- # Animal Crossing New Horizons: Turnip Prophet - -Turnip Prophet is a price calculator/price predictor for Animal Crossing turnip prices. +[![discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=for-the-badge)](https://discord.gg/bRh74X8) +[![issues](https://img.shields.io/github/issues/mikebryant/ac-nh-turnip-prices?style=for-the-badge)](https://github.com/mikebryant/ac-nh-turnip-prices/issues) +[![pull requests](https://img.shields.io/github/issues-pr/mikebryant/ac-nh-turnip-prices?style=for-the-badge)](https://github.com/mikebryant/ac-nh-turnip-prices/pulls) +[![contributors](https://img.shields.io/github/contributors/mikebryant/ac-nh-turnip-prices?style=for-the-badge)](https://github.com/mikebryant/ac-nh-turnip-prices/graphs/contributors) + +Turnip Prophet is a price calculator/price predictor for Animal Crossing New Horizons turnip prices. ## Support From e35f509fbcc5afa22057d1d7008153822103caaa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 22:56:48 +0200 Subject: [PATCH 05/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 548d716..68fe7de 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Turnip Prophet is a price calculator/price predictor for Animal Crossing New Hor ## Support -If you have any questions feel free to join our Discord server ([discord.gg/bRh74X8](https://discord.gg/bRh74X8)) to ask or [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues). +If you have any questions feel free to join our ([discord.gg/bRh74X8](Discord server)) to ask or [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues). Before opening a new issue, we would appreciate it if you would briefly use the search to avoid duplicate questions, because every duplicate question causes other functions to wait ;-) From 3dce7ab6963dd816c403245ba590653ce487ae4d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 22:58:23 +0200 Subject: [PATCH 06/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 68fe7de..1719a61 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Turnip Prophet is a price calculator/price predictor for Animal Crossing New Hor ## Support -If you have any questions feel free to join our ([discord.gg/bRh74X8](Discord server)) to ask or [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues). +If you have any questions feel free to join our [Discord server](https://discord.gg/bRh74X8) to ask or [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues). Before opening a new issue, we would appreciate it if you would briefly use the search to avoid duplicate questions, because every duplicate question causes other functions to wait ;-) From f1b9fc02fd57f039497a71107380f6941f16ff8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 23:07:12 +0200 Subject: [PATCH 07/11] Rewrite table with markdown --- README.md | 34 ++++++---------------------------- 1 file changed, 6 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 1719a61..43e344f 100644 --- a/README.md +++ b/README.md @@ -24,34 +24,12 @@ For details don't hesitate to talk to us, e.g. using our Discord server. At first please have a look at our current project scope: - - - - - - - - - - - - - -
Turnip Prophet is forTurnip Prophet is not for
-
    -
  • A predictor for future prices that week
    • -
  • Able to calculate probabilities for different futures
    • -
  • Able to show data from a query string
    • -
  • A single page web-based app
    • -
- 		-
    -
  • A calculator for how much money you'll make
    • -
  • A way to count your turnips
    • -
  • A way to store multiple people's islands
    • -
  • Something with a backend
    • -
-
+| Turnip Prophet is | Turnip Prophet is not | +|----|----| +| A predictor for future prices that week | A calculator for how much money you'll make | +| Able to calculate probabilities for different futures | A way to count your turnips | +| Able to show data from a query string | A way to store multiple people's islands | +| A single page web-based app | Something with a backend | If your idea, suggestment or improvement is anything out of the above named, feel free to [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues) or contribute by a [new pull request](https://github.com/mikebryant/ac-nh-turnip-prices/pulls). From 862ca931f3aa2dbbbe18c092617100e246540d06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 23:26:18 +0200 Subject: [PATCH 08/11] #178 Add options to run the app locally in README --- README.md | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 43e344f..9da0a56 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,7 @@ Before opening a new issue, we would appreciate it if you would briefly use the Please create issues in English language only. -## Adding a new language - -Turnip Prophet is already available in some languages. If your local language is not listed you may go on to create a language file for it (requires basic git and development skills). - -For details don't hesitate to talk to us, e.g. using our Discord server. - -## What's about feature X? +## What about feature X? At first please have a look at our current project scope: @@ -33,6 +27,35 @@ At first please have a look at our current project scope: If your idea, suggestment or improvement is anything out of the above named, feel free to [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues) or contribute by a [new pull request](https://github.com/mikebryant/ac-nh-turnip-prices/pulls). +## How to run the project locally? + +To run the project locally you will have to clone it and then, from the folder your just cloned, you will have to execute a command. There are multiple options, listed below: + +### Using python + +For python 2.7: + +```python -m SimpleHTTPServer``` + +For python 3: + +```python3 -m http.server``` + +### Using Nodejs + +```npx serve``` + +### Using Chrome + +```google-chrome --allow-file-access-from-files``` + + +## Adding a new language + +Turnip Prophet is already available in some languages. If your local language is not listed you may go on to create a language file for it (requires basic git and development skills). + +For details don't hesitate to talk to us, e.g. using our Discord server. + ## Final statement A special thanks to all who [contribute](https://github.com/mikebryant/ac-nh-turnip-prices/graphs/contributors) to this project, helping improve it and spend their time. From 7cb32748cc21aa1059a2ec4573c512764724d3fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 23:45:50 +0200 Subject: [PATCH 09/11] Add precisions about translation contributions --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9da0a56..fcb81bf 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,12 @@ For python 3: ## Adding a new language -Turnip Prophet is already available in some languages. If your local language is not listed you may go on to create a language file for it (requires basic git and development skills). +Turnip Prophet is already available in some languages. If your local language is not listed you may go on to create a JSON file corresponding to your language in the folder [locales](https://github.com/mikebryant/ac-nh-turnip-prices/tree/master/locales). You may copy the [English localisation](https://github.com/mikebryant/ac-nh-turnip-prices/blob/master/locales/en.json) and translate it. + +Please make sure to **not translate** "Turnip Prophet" and include the new language in the selector inside [js/translations.js](https://github.com/mikebryant/ac-nh-turnip-prices/blob/master/js/scripts.js). + +If you have any remaining questions, feel free to stop by the Discord server and ask. -For details don't hesitate to talk to us, e.g. using our Discord server. ## Final statement From 53fccf2dd7239c7bf3de26a6d7f1421dfec161d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 23:47:00 +0200 Subject: [PATCH 10/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fcb81bf..0d8cba6 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ For python 3: Turnip Prophet is already available in some languages. If your local language is not listed you may go on to create a JSON file corresponding to your language in the folder [locales](https://github.com/mikebryant/ac-nh-turnip-prices/tree/master/locales). You may copy the [English localisation](https://github.com/mikebryant/ac-nh-turnip-prices/blob/master/locales/en.json) and translate it. -Please make sure to **not translate** "Turnip Prophet" and include the new language in the selector inside [js/translations.js](https://github.com/mikebryant/ac-nh-turnip-prices/blob/master/js/scripts.js). +Please make sure **not to translate** "Turnip Prophet" and include the new language in the selector inside [js/translations.js](https://github.com/mikebryant/ac-nh-turnip-prices/blob/master/js/scripts.js). If you have any remaining questions, feel free to stop by the Discord server and ask. From 6f511722fb8deb4d967d678280a3f57d6a2ca886 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lise=20Rubio?= <30841868+Lysoun@users.noreply.github.com> Date: Thu, 23 Apr 2020 23:53:36 +0200 Subject: [PATCH 11/11] Add precisions on opening new issues --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d8cba6..eca368a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Turnip Prophet is a price calculator/price predictor for Animal Crossing New Hor If you have any questions feel free to join our [Discord server](https://discord.gg/bRh74X8) to ask or [open a new issue](https://github.com/mikebryant/ac-nh-turnip-prices/issues). -Before opening a new issue, we would appreciate it if you would briefly use the search to avoid duplicate questions, because every duplicate question causes other functions to wait ;-) +If you have a prediction issue, please open an issue describing your problem and give the permalink to your prediction. Otherwise, please search the issues before opening a new one to make sure you are not opening a duplicate issue. Please create issues in English language only.