Skip to content

Commit 9cfd165

Browse files
authored
Update README.md (#45)
1 parent a7d14db commit 9cfd165

File tree

1 file changed

+0
-40
lines changed

1 file changed

+0
-40
lines changed

README.md

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,5 @@ This repository serves as your comprehensive guide to our engineering standards,
88
Our documentation is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
99
Access detailed documentation in the 'docs' directory. To find specific topics, navigate through the sidebar in the Docusaurus interface or use the search feature.
1010

11-
## What You'll Find Here
12-
This repository includes:
13-
- **Standards**: Best practices and guidelines for maintaining high quality and productivity in engineering.
14-
- **Practices**: Effective techniques and strategies used in our engineering processes.
15-
- **Processes**: Detailed descriptions of our workflows and procedures.
16-
- **Tools**: Resources and tools recommended for optimal engineering outcomes.
17-
18-
## Getting Started
19-
To get started with this repository:
20-
1. Clone the repository to your local machine - `git clone https://github.com/input-output-hk/quality-engineering.git`.
21-
2. Navigate to the repository directory - `cd quality-engineering`.
22-
3. Explore the documents organized in the respective sections.
23-
24-
### Prerequisites
25-
Ensure you have the following installed:
26-
- Node.js (LTS version)
27-
- Yarn package manager
28-
29-
### Installation
30-
To run the documentation locally, perform the following:
31-
1. **Install Dependencies:**
32-
```bash
33-
yarn install
34-
2. **Start the Development Server:**
35-
```bash
36-
yarn start
37-
38-
This will open up a local development server and open your browser to view the Docusaurus site.
39-
40-
## How to Contribute
41-
We highly value your contributions and insights. Here’s how you can help:
42-
1. **Fork** the repository.
43-
2. Create your **feature branch** (`git checkout -b your-new-branch-name`).
44-
3. Commit your changes (`git commit -am 'Add some feature'`).
45-
4. Push to the branch (`git push origin your-new-branch-name`).
46-
5. Open a **pull request**.
47-
48-
## Stay Connected
49-
Stay tuned for more updates and opportunities to engage. Share your insights, help us evolve, and connect with us through **GitHub Issues** or **Pull Requests**.
50-
5111
## License
5212
This project is licensed under the [LICENSE] (link to license) - see the LICENSE file for details.

0 commit comments

Comments
 (0)