Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions on how to run this project #18

Open
dmmarmol opened this issue Feb 2, 2024 · 7 comments
Open

Add instructions on how to run this project #18

dmmarmol opened this issue Feb 2, 2024 · 7 comments

Comments

@dmmarmol
Copy link

dmmarmol commented Feb 2, 2024

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
Copy link
Owner

atas76 commented Feb 2, 2024

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
Copy link
Owner

atas76 commented Feb 16, 2024

For now also, you might want to check this reply I wrote some time ago: #6 (comment)

@UProfit
Copy link

UProfit commented May 11, 2024

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
Copy link
Owner

atas76 commented May 13, 2024

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
Copy link

UProfit commented May 13, 2024 via email

@dmmarmol
Copy link
Author

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

@atas76
Copy link
Owner

atas76 commented May 17, 2024

@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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants