search

aimacode / aima-scala

MIT License
85 stars 34 forks source link

Improvement of the README.md file #3

Open a1shadows opened 6 years ago

a1shadows commented 6 years ago

The README.md file does not provide any information regarding the steps required to run specific parts of the project. Neither does it shed light on the structure of the project.

BusyByte commented 5 years ago

I agree the README is pretty light now. It needs improvements. I would hope once the algorithms, tools, etc... are implemented it mirrors the java version.

a1shadows commented 5 years ago

Are there any plans to work on it? Maybe at GSoc?

a1shadows commented 5 years ago

Sorry, closed it by mistake.

BusyByte commented 5 years ago

I'm not sure if there are any GSoc plans.
I've started to work on implementing the rest of the algorithms. I'll talk with @ctjoreilly on how to publish a jar which can be used. Right now I think I'm instrumenting the byte code for test code coverage.
I'll have to stop doing that so it is usable as a published jar.

a1shadows commented 5 years ago

Maybe opening some issues regarding parts of the project yet to be implemented would encourage some more developers to contribute? I would do it, but I'm not intimately familiar with the project.

BusyByte commented 5 years ago

I think creating some issues to implement the algorithms would be helpful. FYI in b913f98 I shut off the byte code instrumentation.

BusyByte commented 5 years ago

I'll start opening issues for each of them. https://github.com/aimacode/aima-scala/issues/5 is the first but I'll need to figure out how to get an image of the pseudo code into the issue.

a1shadows commented 5 years ago

Will linking to relevant function in https://github.com/aimacode/aima-pseudocode do the trick?

BusyByte commented 5 years ago

That will do the trick nicely. Thanks. I have been using the pdf but links will nice for github issues. I'll get them all created then go back and link to the pseudocode.

BusyByte commented 5 years ago

I created milestones and issues up through chapter 6. I'll create some more here in a bit.

BusyByte commented 5 years ago

I've just finished reading chapter 4 and did some of the algorithms in that chapter already so I'm going to assign myself to those.

BusyByte commented 5 years ago

I have milestones created for all chapters with pseudocode to implement. I'll go back through and create issues for each figure starting with ch7 here in a bit.