File tree 1 file changed +44
-0
lines changed
1 file changed +44
-0
lines changed Original file line number Diff line number Diff line change @@ -18,6 +18,50 @@ This documentation is designed to:
18
18
## Contributing
19
19
We welcome contributions to improve this documentation. If you’d like to add or edit content, feel free to submit a pull request or open an issue.
20
20
21
+ ### Prerequisites
22
+
23
+ Before you begin, ensure you have the following installed on your system:
24
+
25
+ - ** Node.js** : [ Download and install Node.js] ( https://nodejs.org/ ) (LTS version recommended).
26
+ - ** pnpm** : A fast, disk space-efficient package manager. Install it globally if you don’t already have it:
27
+ ``` bash
28
+ npm install -g pnpm
29
+ ```
30
+ ### Step 1: Clone the Repository
31
+
32
+ Clone the repository to your local machine and navigate into the project directory:
33
+
34
+ ``` bash
35
+ git clone https://github.com/yourusername/tinyml-hackathon-docs.git
36
+ cd tinyml-hackathon-docs
37
+ ```
38
+
39
+ ### Step 2: Install Dependencies
40
+
41
+ Install the required dependencies using pnpm:
42
+
43
+ ``` bash
44
+ pnpm i
45
+ ```
46
+
47
+ ### Step 3: Start the Development Server
48
+
49
+ Run the following command to start the local development server:
50
+
51
+ ``` bash
52
+ pnpm dev
53
+ ```
54
+
55
+ By default, the documentation page will be accessible at:
56
+
57
+ ```
58
+ http://localhost:3000
59
+ ```
60
+
61
+ Open this URL in your browser to view the documentation page.
62
+
63
+
64
+
21
65
## Additional Information
22
66
- ** Website** : Visit [ tinyMLHack] ( https://tinymlhack.com/ ) for more details about the hackathon.
23
67
- ** Support** : Reach out to the organizers if you have any questions or need assistance.
You can’t perform that action at this time.
0 commit comments