Skip to content

Commit 1f81e2d

Browse files
committed
integrate initial readme
0 parents  commit 1f81e2d

1 file changed

Lines changed: 111 additions & 0 deletions

File tree

README.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Information Search
2+
3+
## **1. Overview**
4+
5+
**Information Search** is a specialized utility designed to streamline access to **FPGA documentation** on the **Microchip** website.
6+
7+
With **Information Search**, users can quickly locate:
8+
9+
* Datasheets
10+
* Application notes
11+
* Reference manuals
12+
* Other technical resources
13+
14+
All results are sourced **directly from official Microchip FPGA web resources**.
15+
This tool is ideal for **engineers**, **developers**, and **administrators** who require **fast, reliable access** to the latest FPGA documentation.
16+
17+
---
18+
19+
## **2. Features**
20+
21+
* **High-speed search** across all Microchip FPGA documentation
22+
* **Filter by document type** (datasheet, application note, manual, etc.)
23+
* **Customizable search parameters** for more targeted and efficient results
24+
25+
---
26+
27+
## **3. System Requirements**
28+
29+
| Requirement | Details |
30+
| -------------------- | ---------------------------------------------------- |
31+
| **Operating System** | Windows 10 / Windows 11 |
32+
| **Privileges** | Local administrator rights required for installation |
33+
| **Memory** | Minimum 4 GB RAM |
34+
| **Disk Space** | Minimum 1 GB free space |
35+
36+
---
37+
38+
## **4. Installation Instructions**
39+
40+
> **Important:** You **must** have *local administrator privileges* to install Information Search.
41+
> If you do not have these privileges, please contact your IT department.
42+
43+
### **Windows Installation Steps**
44+
45+
1. **Download the installer** from one of the following locations:
46+
47+
* Releases: [https://github.com/MicrochipTech/information-search/releases](https://github.com/MicrochipTech/information-search/releases)
48+
2. **Right-click** the downloaded installer and select **“Run as administrator.”**
49+
3. Follow the **on-screen prompts** to complete the installation.
50+
51+
---
52+
53+
## **5. Important Download Notice**
54+
55+
When viewing the **GitHub release page**, you will see multiple files under the **Assets** section.
56+
57+
Please **download only the `.exe` file** - for example:
58+
59+
```
60+
infosearch-2025.10.15.exe
61+
```
62+
63+
Do **not** download the automatically generated files labeled:
64+
65+
* **Source code (zip)**
66+
* **Source code (tar.gz)**
67+
68+
These are automatically created by GitHub and **do not contain the actual application/any source code**.
69+
70+
**Download this:**
71+
`infosearch-<release-number>.exe`
72+
73+
**Ignore these:**
74+
`Source code (zip)`
75+
`Source code (tar.gz)`
76+
77+
---
78+
79+
## **6. Usage**
80+
81+
1. **Launch** your preferred web browser.
82+
2. **Navigate** to:
83+
84+
```
85+
http://localhost:5002/
86+
```
87+
88+
or use the **hostname and port** specified during installation.
89+
3. **Enter keywords** to search for FPGA documentation on the Microchip website.
90+
4. **Filter** results by:
91+
92+
* Document type
93+
* Product family
94+
* Other search parameters
95+
96+
---
97+
98+
## **7. Support & Documentation**
99+
100+
For troubleshooting and further assistance:
101+
102+
* Open the **Information Search** interface.
103+
* Click **Help** on the **right-hand side** of the top banner to access the **User Guide**.
104+
105+
---
106+
107+
### **Contact**
108+
109+
For additional support or feedback, please reach out via your organization’s IT or Microchip technical support channel.
110+
111+
---

0 commit comments

Comments
 (0)