Skip to content

Fixing some format issues in README. #10

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 8, 2022
Merged

Fixing some format issues in README. #10

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af0f67a
Fixing some format issues in README.
germa89 Jun 7, 2022
ea7c1dd
Second fix
germa89 Jun 7, 2022
fed6291
Merge branch 'main' into fix/readme-format-issues
mkundu1 Jun 8, 2022
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
56 changes: 28 additions & 28 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Pyfluent visualization
:target: https://codecov.io/gh/pyansys/pyfluent-visualization
:alt: Codecov

.. |GH-CI| image:: https://github.com/pyansys/pyfluent-visualization/actions/workflows/ci.yml/badge.svg
:target: https://github.com/pyansys/pyfluent-visualization/actions/workflows/ci.yml
.. |GH-CI| image:: https://github.com/pyansys/pyfluent-visualization/actions/workflows/ci_cd.yml/badge.svg
:target: https://github.com/pyansys/pyfluent-visualization/actions/workflows/ci_cd.yml
:alt: GH-CI

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
Expand Down Expand Up @@ -66,48 +66,48 @@ need to follow these steps:

1. Start by cloning this repository:

.. code:: bash
.. code:: bash

git clone https://github.com/pyansys/pyfluent-visualization
git clone https://github.com/pyansys/pyfluent-visualization

2. Create a fresh-clean Python environment and activate it:

.. code:: bash
.. code:: bash

# Create a virtual environment
python -m venv .venv
# Create a virtual environment
python -m venv .venv

# Activate it in a POSIX system
source .venv/bin/activate
# Activate it in a POSIX system
source .venv/bin/activate

# Activate it in Windows CMD environment
.venv\Scripts\activate.bat
# Activate it in Windows CMD environment
.venv\Scripts\activate.bat

# Activate it in Windows Powershell
.venv\Scripts\Activate.ps1
# Activate it in Windows Powershell
.venv\Scripts\Activate.ps1

3. Make sure you have the latest required build system and doc, testing, and CI tools:

.. code:: bash
.. code:: bash

python -m pip install -U pip poetry tox
python -m pip install -r requirements/requirements_build.txt
python -m pip install -r requirements/requirements_doc.txt
python -m pip install -r requirements/requirements_tests.txt
python -m pip install -U pip poetry tox
python -m pip install -r requirements/requirements_build.txt
python -m pip install -r requirements/requirements_doc.txt
python -m pip install -r requirements/requirements_tests.txt


4. Install the project in editable mode:

.. code:: bash
.. code:: bash

cd pyfluent-visualization
poetry run python -m pip install .
cd pyfluent-visualization
poetry run python -m pip install .

5. Finally, verify your development installation by running:
5. Finally, verify your development installation by running:

.. code:: bash
tox
.. code:: bash

tox


How to testing
Expand Down Expand Up @@ -147,7 +147,7 @@ encouraged to install this tool via:

.. code:: bash

python -m pip install pre-commit && pre-commit install
python -m pip install pre-commit && pre-commit install


Documentation
Expand Down Expand Up @@ -181,8 +181,8 @@ Then, you can execute:

.. code:: bash

poetry build
python -m twine check dist/*
poetry build
python -m twine check dist/*

.. LINKS AND REFERENCES
.. _black: https://github.com/psf/black
Expand Down