Conversation
|
Skipped: This PR changes more files than the configured file change limit: ( |
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
ce897fe to
2a45a5a
Compare
81601a8 to
c7aa30a
Compare
baaf36d to
5d76b4c
Compare
c7aa30a to
1eb4f6d
Compare
5d76b4c to
f830f96
Compare
1eb4f6d to
8f0129c
Compare
f830f96 to
a47cb99
Compare
8f0129c to
7f5becd
Compare
083acde to
a6bcb4c
Compare
263e836 to
5350d2e
Compare
108084f to
b7dcbfa
Compare
dc6cbab to
6d0e96d
Compare
9f83275 to
46858e5
Compare
6d0e96d to
b7f7855
Compare
docs/quickstart.md
Outdated
| ### Install DimOS | ||
|
|
||
| ```python | ||
| pip install -U dimos |
There was a problem hiding this comment.
this wouldnt work im pretty sure since dimos isnt in PyPi public distro yet
There was a problem hiding this comment.
yes, the install instructions are aspirational / placeholders -- there's a comment to that effect. But maybe I should make it clearer it's TBD
There was a problem hiding this comment.
I've updated it to make it more explicit that the installation instructions part is just a placeholder. Hopefully after #731 lands and after release, it really will be that easy to install dimos. (Actually after that PR lands, it might be possible to do pip install git+ssh://git@github.com/dimensionalOS/dimos.git even without adding it to PyPi).
(I could link to the current installation instructions, but I really do think the installation needs to be made simpler for non-contributor users. The user-oriented quickstart needs to look quick.)
46858e5 to
b61971e
Compare
b7f7855 to
517475e
Compare
b61971e to
f6fde16
Compare
4929c6a to
d78c094
Compare
f6fde16 to
1a4c7de
Compare
d78c094 to
1315c1d
Compare
1a4c7de to
894440c
Compare
1315c1d to
7b78a5a
Compare
894440c to
871981c
Compare
I made a separate quickstart doc and linked to it from the README, to make the README less cluttered -- that's how https://github.com/Eventual-Inc/Daft/blob/main/README.rst does it too. But I could also inline it into the README if that's what is preferred.
The quickstart doesn't get you to run a quick Mujoco simulation, but maybe it should. Then again, it's also important for a quickstart to be super concise.
The README needs more cleaning up -- I would personally go for a structure like Daft's -- but that probably shouldn't be part of this PR.