Skip to content

Commit 57b517e

Browse files
committed
fix: update README for clarity and organization, including prerequisites and setup instructions
1 parent 4f426a0 commit 57b517e

File tree

1 file changed

+91
-29
lines changed

1 file changed

+91
-29
lines changed

README.md

Lines changed: 91 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
1-
# iExec Tools documentation
1+
# iExec Documentation
22

3-
This is the source repository of the [iExec documentation](https://docs.iex.ec)
3+
## 📋 Prerequisites
44

5-
## Prerequisites
5+
- **Node.js**: Version 22 or higher
6+
- **npm**: Comes bundled with Node.js
67

7-
- Node 22
8-
9-
## Configuration
8+
## ⚙️ Configuration
109

1110
### Environment Variables (Optional)
1211

13-
Some features of the application require environment variables. This
14-
configuration is optional and only needed if you plan to work with Hello World
15-
pages. Create a `.env` file at the root of the project using the provided
16-
`.env.example` as a template:
12+
Some features of the application require environment variables. This configuration is optional and only needed if you plan to work with Hello World pages.
13+
14+
Create a `.env` file at the root of the project using the provided `.env.example` as a template:
1715

1816
```bash
1917
cp .env.example .env
@@ -36,39 +34,103 @@ To obtain your `VITE_REOWN_PROJECT_ID`, follow these steps:
3634
- Project name
3735
- Description (optional)
3836
- Website URL (optional)
39-
5. Once the project is created, copy the "Project ID" displayed in the project
40-
details
37+
5. Once the project is created, copy the "Project ID" displayed in the project details
4138
6. Paste this ID in your `.env` file as the value for `VITE_REOWN_PROJECT_ID`
4239

43-
## Run app
40+
## 🚀 Getting Started
4441

45-
```
42+
### Installation
43+
44+
Install the project dependencies:
45+
46+
```bash
4647
npm install
48+
```
49+
50+
### Development Server
51+
52+
Start the development server:
53+
54+
```bash
4755
npm run dev
4856
```
4957

50-
## Contributing
58+
The documentation site will be available at `http://localhost:3000` (or the port shown in your terminal).
59+
60+
### Building for Production
61+
62+
To build the project for production:
63+
64+
```bash
65+
npm run build
66+
```
67+
68+
## 🤝 Contributing
69+
70+
We welcome contributions to improve the iExec documentation! Please follow these steps to contribute:
71+
72+
### 1. Fork the Repository
73+
74+
Fork this repository and ensure you're working on the `main` branch:
75+
76+
[![fork-button](./src/public/fork-button.png)](https://github.com/iExecBlockchainComputing/documentation/fork)
77+
78+
### 2. Set Up Your Development Environment
79+
80+
1. Clone your forked repository:
81+
```bash
82+
git clone https://github.com/YOUR_USERNAME/documentation.git
83+
cd documentation
84+
```
85+
86+
2. Install dependencies:
87+
```bash
88+
npm install
89+
```
90+
91+
3. Start the development server:
92+
```bash
93+
npm run dev
94+
```
95+
96+
### 3. Make Your Changes
97+
98+
1. Create a new branch for your feature/fix:
99+
```bash
100+
git checkout -b feature/your-feature-name
101+
```
102+
103+
2. Make your changes to the documentation
104+
3. Test your changes locally to ensure they work as expected
51105

52-
To keep the contribution process smooth, please read this small guide.
106+
### 4. Submit Your Changes
53107

54-
### Fork
108+
1. Stage and commit your changes with a descriptive message:
109+
```bash
110+
git add .
111+
git commit -m "Add: descriptive commit message"
112+
```
55113

56-
Fork the repo and be sure to be on `main` branch
114+
2. Push your changes to your forked repository:
115+
```bash
116+
git push origin feature/your-feature-name
117+
```
57118

58-
[![fork-button](./public/fork-button.png)](https://github.com/iExecBlockchainComputing/documentation/fork)
119+
3. Open a pull request from your feature branch to our `main` branch
59120

60-
### Contribute
121+
### 5. Review Process
61122

62-
Apply your changes on your forked branch, stage them and commit them with a
63-
descriptive commit message.
123+
> **💡 Tips:**
124+
> - You can open a draft pull request and mark it as "Ready for review" once you're satisfied with the preview
125+
> - All pull requests are reviewed by our team before being merged
126+
> - Feel free to ask questions in the pull request if you need clarification
64127
65-
Push your changes to your forked branch.
128+
## 📄 License
66129

67-
### PR time
130+
This project is part of the iExec ecosystem. Please refer to the main iExec repositories for licensing information.
68131

69-
Open a pull request from your forked branch to our `main` branch.
132+
## 🆘 Support
70133

71-
> _**Tips:**_
72-
> You can open a draft pull request and set it to "Ready for review" once you
73-
> are happy with the preview. Opened pull requests will be reviewed by the team
74-
> and merged once approved.
134+
- 📖 [Documentation](https://docs.iex.ec)
135+
- 💬 [Discord Community](https://discord.com/invite/pbt9m98wnU)
136+
- 🐛 [Issue Tracker](https://github.com/iExecBlockchainComputing/documentation/issues)

0 commit comments

Comments
 (0)