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

Additional Information Added to README.md #1721

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,55 @@
follow our [building Open Chemistry][Build] guide that will take care of
building most dependencies.

## Steps for Basic Installation

Check notice on line 49 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L49

Expected: 0 or 2; Actual: 1

### macOS

Check notice on line 51 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L51

Expected: 1; Actual: 0; Below
1. Install Homebrew (if not installed):

Check notice on line 52 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L52

Lists should be surrounded by blank lines

Check notice on line 53 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L53

Expected: 0 or 2; Actual: 3
`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`

2. Install Dependencies:

`brew install cmake qt5 eigen`

4. Clone and Build

Check notice on line 60 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L60

Expected: 3; Actual: 4; Style: 1/2/3

`brew link qt --force`

6. Build with CMake

Check notice on line 64 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L64

Expected: 4; Actual: 6; Style: 1/2/3

Check notice on line 64 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L64

Lists should be surrounded by blank lines
```

Check notice on line 65 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L65

Fenced code blocks should be surrounded by blank lines

Check notice on line 65 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L65

Fenced code blocks should have a language specified
mkdir build
cd build
cmake ..
make
sudo make install
```
### Windows

Check notice on line 72 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L72

Expected: 1; Actual: 0; Above
1. Install Required Tools

Check notice on line 73 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L73

Lists should be surrounded by blank lines
* Download and install CMake
* Install Qt
* Install Visual Studio with C++ development tools
2. Clone the Repository

`git clone https://github.com/OpenChemistry/avogadrolibs.git
cd avogadrolibs
`
3. Configure with CMake GUI:
* Open CMake GUI, selecr the **source folder** (where ``CMakeLists.txt`` is located)
* Set the **build folder** (e.g., ``build/``)
* Configure for your Visual Studio Version
4. Generate Solution
* Click "Generate" to create ``.sln`` file
5. Build with Visual Studio
* Open the ``.sln`` file in Visual Stuio and select **release** and **debug** mode

Check notice on line 89 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L89

Expected: 80; Actual: 85
* Click **Build Solution**

## General Troubleshooting

* Permission Errors: On macOS and Linux, use ``sudo`` for installation
* Build Fails: Ensure dependencies are installed and the correct C++ version is selected
* Missing Eigen or Qt: Manually pass their paths to CMake using ``-DCMAKE_PREFIX_PATH``.

## Contributing

We welcome *all* kinds of contributions as a community project, from bug
Expand Down Expand Up @@ -75,3 +124,7 @@
[Build]: https://two.avogadro.cc/install/build.html "Building Avogadro"
[Contribution]: https://two.avogadro.cc/contrib/ "Contribution guide"
[API]: https://two.avogadro.cc/api/ "API documentation"

## Licensing

To know more about our license please refer to [Avogadro License Information](https://github.com/OpenChemistry/avogadrolibs/blob/master/LICENSE).