Add instructions on how to run this project

[dmmarmol]

It'd be nice to have a brief introduction at the README.md explaining how to install & run this project. This will help any potential contributor to dive into the code & mechanics and push this project even further.

I personally don't know how to compile it, otherwise I'd create a PR with the instructions.

[atas76]

Hello,

Yes, you are right. The reason for not doing that thus far is that this project has been mostly experimental, basically talking to myself in public. In reality, it's composed of many little sub-projects and different approaches. This is going to change in the near future, as I am putting things together and reviewing what I have done so far. Once I write documentation on what's coming next, and have things working, then I will give specific instructions not only on how to run, but also what is supposed to run.

My current idea is to have two sub-projects, from which everything else will develop, but I'll write more details on that on the current documentation I am writing.

Another reason I neglected to put any specific instructions is that these should be obvious to anyone familiar with Java, but not anyone is a Java programmer, of course. In short, the quickest instructions I can give is to install Java, install IntelliJ Community Edition (or similar IDE, but this is what I am using and it's kind of standard): https://www.jetbrains.com/idea/download and open the project with it. Also you need Maven for dependency management: https://maven.apache.org/. With IntelliJ IDE, things should be fairly automatic, there may be a few things to take care of regarding configuration. Generally, it is a matter of setting up a Java project, and there is nothing peculiar in the project itself. As I said, there are several things that can be run, so I need to write documentation for this as well. These are the quickest instructions I can give right now. I promise to write a complete documentation on that after I finish working with current documentation and issues, and thank you also for pointing that out.

[atas76]

For now also, you might want to check this reply I wrote some time ago: https://github.com/atas76/openengine/issues/6#issuecomment-595510258

[UProfit]

Hello,

Great project, this should see the light.

Can you help me run it? am not a tech guy. dowloaded IDEA and download code, compile on IDEA, but i dont know how to run it? Can you help me on this?

Tks

[atas76]

Hi,

If you open the project on IDEA, you can run it through one of the "main" methods, which are the starting points in Java (and other similar languages) for running an application.

The thing is that the project itself contains a lot of different programs which correspond to many different approaches and experiments, although with s similar concept, so you can expect to run more like different projects rather than a single big one project (at this time, at least), by running the corresponding main() method.

That's also a reason for not prioritising writing instructions or running the project 'out of the box': I need to finalize the current stage of the project, and then decide on what the project actually should be. If you don't have experience with Java or programming in general, then it may be a bit tricky to run it. Tell me what you need help with regarding the project itself (and I would really like to hear how people see the project in general at this relatively early stage). For the more technical issues of using IntelliJ IDEA, you can familiarise through a tutorial or use GPT, for example, to guide you.

The shortest instruction I could give: look for "main" (methods) in the code and press the 'play' icon next to them :-)

[UProfit]

Hi,

I see the project running as a Multiplayer online game, based on NFT players that allow each coach to create their club and come up in divisions playing against other real users. Currently we have a fantasy game already develop but we are looking to continue the game to a more virtual club owning experience, would you care to collaborate with us?

El lunes, 13 de mayo de 2024, Andreas @.***> escribió:

Hi,

If you open the project on IDEA, you can run it through one of the "main" methods, which are the starting points in Java (and other similar languages) for running an application.

The thing is that the project itself contains a lot of different programs which correspond to many different approaches and experiments, although with s similar concept, so you can expect to run more like different projects rather than a single big one project (at this time, at least), by running the corresponding main() method.

That's also a reason for not prioritising writing instructions or running the project 'out of the box': I need to finalize the current stage of the project, and then decide on what the project actually should be. If you don't have experience with Java or programming in general, then it may be a bit tricky to run it. Tell me what you need help with regarding the project itself (and I would really like to hear how people see the project in general at this relatively early stage). For the more technical issues of using IntelliJ IDEA, you can familiarise through a tutorial or use GPT, for example, to guide you.

The shortest instruction I could give: look for "main" (methods) in the code and press the 'play' icon next to them :-)

— Reply to this email directly, view it on GitHub https://github.com/atas76/openengine/issues/18#issuecomment-2107410226, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYOX3CBJARSYW5F4LYNCEA3ZCCUYRAVCNFSM6AAAAABCW36CW6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMBXGQYTAMRSGY . You are receiving this because you commented.Message ID: @.***>

--

Erik V. UPROFIT TRADER

Email: @.***

Site: www.uprofit.com

https://www.facebook.com/UProfitTrader/ https://www.instagram.com/uprofittrader/ https://www.youtube.com/channel/UCo-c1Fw53EX3ixapFbG9L0g https://www.linkedin.com/company/uprofittrader/mycompany/

The information in this email, including any attachments, contains information from The UProfit Trader, LLC, which may be confidential and privileged. This email is intended to be viewed only by the individual or organization named above. Any use, dissemination, forwarding, distribution, printing, or reproduction of this e-mail and its attachments, if any, without consent of the originator is strictly prohibited. If you have received this e-mail in error, please immediately notify the sender by “reply to sender only” message and destroy all electronic and hard copies of the communication, including attachments.

[dmmarmol]

@UProfit That project sounds interesting!. Is that an open source project that we could check/contribute?

[atas76]

@UProfit yeah, that's more like on the business side. One use of this match engine (which is one of the many I am developing) could be in projects such as the one you mention, but this is not exhaustive. I am currently aiming at something broader than that, something along the lines of exploring 'what if' scenarios. At this point my focus is more on the 'research' aspects rather than the business side or possible applications. I would be interested to see what you are doing, but most probably I wouldn't be able to collaborate actively (time being among the main issues).