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

Update documentation #7

Open
mfarina1 opened this issue Sep 26, 2024 · 1 comment
Open

Update documentation #7

mfarina1 opened this issue Sep 26, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mfarina1
Copy link
Collaborator

Update README and the generated API Python docs

@mfarina1 mfarina1 added the documentation Improvements or additions to documentation label Sep 26, 2024
@mfarina1 mfarina1 added this to the ACE v2.0.0 milestone Sep 26, 2024
@mfarina1
Copy link
Collaborator Author

mfarina1 commented Oct 7, 2024

Potential updates to README:

  • include command: git submodule update --init --recursive for resolving certain installation errors
  • Add instructions for working in Python virtual environment with proper version of python
  • Suggest running pip3 install command as two commands

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

When branches are created from issues, their pull requests are automatically linked.

1 participant