Molara-Lab / Molara

Molara is a Python package for the visualization of chemical structures such as molecules or crystals. It provides a graphical user interface for importing structures from output files of popular computational chemistry software as well as for creating custom structures.
GNU General Public License v3.0
11 stars 0 forks source link

Update README.md: Simplified install instructions #355

Closed adrianusler closed 2 months ago

adrianusler commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent update involves simplifying the installation instructions by removing the specific command python -m cython_build build_ext --inplace from the README.md file. This change likely aims to streamline the setup process or reflects an adjustment in the project's build requirements.

Changes

File Change Summary
README.md Removed Cython build command from installation steps

🐇✨ In the README's gentle glow,
A line of code was let to go.
No more complex commands to type,
Installation now a breeze, just right!
Hop, hop, hooray! 🎉🌟


Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between ee1c5b10aa265f0a25b7e6b9f6a9c66019dc2d42 and 75303757f6a6577d806237836dcee1cb26016860.
Files selected for processing (1) * README.md (1 hunks)
Additional Context Used
LanguageTool (11)
README.md (11)
Near line 4: Possible typo: you repeated a word Context: ...latest/github/Molara-Lab/Molara/main) # Molara Molara is an open-source program for the 3-dim... --- Near line 7: Don’t put a space before the full stop. Context: ...f its main features: 1. Import of .xyz, .coord, and POSCAR files 2. Export of ren... --- Near line 7: Possible spelling mistake found. Context: ...its main features: 1. Import of .xyz, .coord, and POSCAR files 2. Export of rendered... --- Near line 7: Possible spelling mistake found. Context: ...atures: 1. Import of .xyz, .coord, and POSCAR files 2. Export of rendered structures ... --- Near line 12: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1294 characters long) Context: ...jectories New features will follow soon! ## Installation You first need to clon... --- Near line 21: Possible spelling mistake found. Context: ... Molara ``` It is advisable to install Molara in a virtual Python environment. Vi... --- Near line 34: Possible spelling mistake found. Context: ...Scripts\activate.bat ``` Subsequently, Molara may be installed as follows. ``` pip in... --- Near line 39: Possible spelling mistake found. Context: ... To generate the documentation, install molara as follows: ```bash pip install -e . m... --- Near line 55: Possible spelling mistake found. Context: ...docs make html ``` Note that, for the Cython build, a C compiler must be installed o... --- Near line 57: Possible spelling mistake found. Context: ...nstall.html)). After the installation, Molara may then be started (within the virtual... --- Near line 57: Possible spelling mistake found. Context: ...hin the virtual environment) by calling `molara` from the command line.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.