diff --git a/README.md b/README.md index 323eb3f..43136de 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Welcome to the OPFEM repository, an open-source Python-based finite element mode Please explore the following sections to get started with OPFEM: -- **[Quick Start](/docs/quick_start/quick_start.md):** A guide to quickly set up and run OPFEM on your system. +- **[Quick Start](/docs/quick_start.md):** A guide to quickly set up and run OPFEM on your system. - **[Usage](#usage):** Learn how to use OPFEM for your finite element modeling projects. - **[Contribution Guidelines](#contribution-guidelines):** Interested in contributing to OPFEM? Find information on how to get involved. - **[Contact](#contact):** Need assistance or have questions? Reach out to us. diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 58099ec..0000000 --- a/docs/README.md +++ /dev/null @@ -1,28 +0,0 @@ -# OPFEM: Open-Source Python-Based Finite Element Modeling (OPFEM) - -Welcome to the OPFEM repository, an open-source Python-based finite element modeling software. OPFEM is designed to provide a flexible and accessible tool for finite element analysis in various engineering and scientific applications. - -## Table of Contents - -Please explore the following sections to get started with OPFEM: - -- **[Quick Start](./quick_start/quick_start.md):** A guide to quickly set up and run OPFEM on your system. -- **[Usage](#usage):** Learn how to use OPFEM for your finite element modeling projects. -- **[Contribution Guidelines](#contribution-guidelines):** Interested in contributing to OPFEM? Find information on how to get involved. -- **[Contact](#contact):** Need assistance or have questions? Reach out to us. - -## Quick Start - -Here, we provide a step-by-step guide on how to quickly get started with OPFEM. Follow these instructions to set up the software and begin your finite element modeling journey. - -## Usage - -Explore the capabilities and features of OPFEM. Learn how to utilize this software for your specific modeling needs. We provide documentation and examples to help you effectively apply OPFEM to your projects. - -## Contribution Guidelines - -We welcome contributions from the open-source community. Whether you want to fix a bug, add a feature, or improve the documentation, your contributions are valuable. Please read our contribution guidelines to understand how you can actively participate in the development of OPFEM. - -## Contact - -If you have any questions, need support, or want to get in touch with the OPFEM community, you can find our contact information and resources here. We're here to assist you on your OPFEM journey. diff --git a/docs/quick_start/quick_start.md b/docs/quick_start.md similarity index 88% rename from docs/quick_start/quick_start.md rename to docs/quick_start.md index 56b2edc..266c78c 100644 --- a/docs/quick_start/quick_start.md +++ b/docs/quick_start.md @@ -10,4 +10,4 @@ Before you begin, make sure you have the following prerequisites installed on yo 2. **Conda (Optional)**: Consider installing Conda to create virtual environments and manage dependencies. You can download Miniconda or Anaconda from the [official website](https://docs.conda.io/en/latest/miniconda.html). -The details of the installation and the basic knowledge of Conda is introduced in [Install Anaconda and Python](/docs/quick_start/install_anaconda_and_python.md). +The details of the installation and the basic knowledge of Conda is introduced in [Install Anaconda and Python](./quick_start/install_anaconda_and_python.md).