buckyroberts / Ella

Self-improving decision organism
447 stars 85 forks source link

Installation and usage instructions #4

Closed oojacoboo closed 7 years ago

oojacoboo commented 7 years ago

Hey, looked through the source a bit and didn't see any API keys, configs, etc.

Is everything hard coded? It'd be great if you could update the README to include details on installation and usage.

Executing the main.py gives me a SyntaxError:

Traceback (most recent call last):
  File "./main.py", line 1, in <module>
    from models.brain import Brain
  File "/Volumes/repos/Ella/models/brain.py", line 2, in <module>
    from models.condition import Condition
  File "/Volumes/repos/Ella/models/condition.py", line 15
    return f"{self.attribute} {operator_to_str(self.operator)} {self.value}"
                                                                           ^
SyntaxError: invalid syntax

Is there a minimum required version of python?

sqro2 commented 7 years ago

Is there a minimum required version of python? Python 3.6 (or newer) required (included in Readme.md file)

yes I agree to the fact that there should be detailed uses guide for beginners.

buckyroberts commented 7 years ago

No API key required, it uses all public API endpoints. Also in the README it states Python 3.6 (or newer) required.

oojacoboo commented 7 years ago

Thanks, I see that now. It'd be nice to add a requirements and installation sections. Those are far more common and generally at the top of the readme, due to importance.

buckyroberts commented 7 years ago

Good thinking @oojacoboo , I will update it on my next commit!