Skip to content

Commit 2716c6d

Browse files
committed
improved the readme file for thsi project
1 parent a7bd442 commit 2716c6d

1 file changed

Lines changed: 28 additions & 80 deletions

File tree

README.md

Lines changed: 28 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,43 @@
11

2+
# rss_cse_picker
23

3-
# DevSetup
4+
## Overview
45

5-
## Overview
6+
**rss_cse_picker** is a simple service that provides a ready-to-use OPML file containing curated RSS/Atom feeds.
7+
Users don’t need to worry about JSON, Excel, or conversions — they can directly **download the OPML file** and import it into any feed reader (like Feedly, Inoreader, or Thunderbird).
68

7-
DevSetup is a web-based tool that generates installation scripts for various tools and software based on the user's OS and preferred package manager. It allows developers to easily select tools they want to install, and it generates a script that can be run on their system (Windows, macOS, or Linux).
9+
For developers and contributors, feeds are maintained in an Excel file (`feeds.xlsx`) and converted into OPML using a Node.js script.
810

9-
This project simplifies setting up a developer environment by providing a streamlined process to install essential tools using the appropriate package manager for the user's operating system.
11+
## For Users
1012

11-
## Why We Need It
13+
- Just download the **OPML file** from the releases/download section.
14+
- Import it into your favorite RSS reader.
15+
- Done ✅ — you’re subscribed to all curated feeds.
1216

13-
Setting up a development environment involves installing multiple tools, such as IDEs, version control systems, package managers, etc. Each tool may require a different installation method depending on the operating system you're using.
17+
## For Contributors / Developers
1418

15-
DevSetup allows developers to:
19+
If you want to add or improve feeds:
1620

17-
- Select their operating system (Windows, macOS, or Linux)
18-
- Choose the package manager they prefer (e.g., Homebrew for macOS, Chocolatey for Windows, APT for Linux)
19-
- Generate a custom installation script that installs the selected tools automatically
20-
21-
With this tool, you can automate the setup of a developer environment, ensuring you don't miss any dependencies or tools.
22-
23-
## Features
24-
25-
- **Operating System Selector**: Choose between Windows, macOS, or Linux.
26-
- **Package Manager Selector**: Select from various package managers (e.g., `choco`, `winget`, `scoop`, `homebrew`, `apt`).
27-
- **Tool Selector**: Browse through different categories of developer tools, check the ones you want to install.
28-
- **Script Generation**: Automatically generate a script (e.g., shell script for Linux/macOS or batch script for Windows) that installs the selected tools via the package manager.
29-
- **Copy to Clipboard**: Copy the generated script to the clipboard for easy pasting into the terminal.
30-
- **Download Script**: Download the generated script as a `.sh` file for Linux/macOS or `.bat` file for Windows.
31-
32-
## How It Works
33-
34-
1. **Load Data**: The tool loads a JSON file containing a list of tools and their installation commands for each package manager. This data is structured into categories (e.g., IDEs, utilities, version control tools).
35-
2. **OS & Package Manager Selection**: The user selects their operating system and package manager.
36-
3. **Tool Selection**: The user checks off the tools they wish to install. Only tools compatible with the selected OS and package manager are available.
37-
4. **Script Generation**: Once the tools are selected, a script is automatically generated with the appropriate installation commands.
38-
5. **Action Buttons**: The user can copy the script to the clipboard or download it for later use.
39-
40-
## Use Cases
41-
42-
- **New Developer Setup**: Quickly set up a new development environment with all the necessary tools.
43-
- **Consistency Across Machines**: Ensure all developers on a team have the same tools installed with identical setup scripts.
44-
- **Automated Dev Environment Setup**: Automate the installation of development tools during CI/CD pipelines or on virtual machines.
45-
46-
## How to Use
47-
48-
1. **Clone the Repository**
49-
- Clone this repository to your local machine.
50-
51-
```bash
52-
git clone https://github.com/yourusername/devsetup.git
53-
cd devsetup
54-
```
55-
56-
2. **Install Dependencies**
57-
58-
* Install the required dependencies for React and Next.js.
59-
60-
```bash
61-
npm install
62-
```
63-
64-
3. **Run the Application**
65-
66-
* Start the development server to run the application locally.
21+
1. **Edit `feeds.xlsx`**
22+
- Required columns:
23+
- `category` – grouping label (e.g., AI, WebDev, CSE)
24+
- `title` – name of the site/blog
25+
- `xmlUrl` – RSS/Atom feed link
26+
- *(optional)* `htmlUrl` – human-facing blog link
6727

28+
2. **Run the Converter**
6829
```bash
69-
npm run dev
70-
```
71-
72-
Visit [http://localhost:3000](http://localhost:3000) to interact with the tool.
73-
74-
4. **Select Tools**
75-
76-
* Select your operating system (Windows, macOS, or Linux).
77-
* Choose the package manager (e.g., `choco`, `winget`, `apt`, etc.).
78-
* Check the boxes for the tools you wish to install.
79-
* Click "Generate Script" to create your installation script.
80-
81-
5. **Copy or Download the Script**
82-
83-
* Copy the script to the clipboard or download it as a `.sh` or `.bat` file.
84-
85-
---
86-
## Contributing
87-
88-
We'd love to have your help! Please see the [Contributing Guide](CONTRIBUTING.md) for instructions on how to add new tools or contribute to the project.
30+
node convertExcelToJson.js
31+
```
32+
This produces a `feeds.json`.
8933

34+
3. **Generate OPML**
35+
Another script transforms `feeds.json` into an `feeds.opml` file that can be shared with end-users.
9036

91-
## Conclusion
37+
📄 A separate `CONTRIBUTING.docx` is included with step-by-step instructions for developers.
9238

93-
DevSetup is a simple yet powerful tool that can save time when setting up a new development environment. By automating the installation of essential tools, it ensures consistency and efficiency across multiple systems. With the ability to add new tools via an Excel file, this project can easily scale and accommodate more software options.
39+
## Why This Project
9440

95-
---
41+
- **For users**: Instant OPML, no setup needed.
42+
- **For maintainers**: Easy feed management in Excel.
43+
- **For developers**: Simple contribution workflow via JSON/Excel.

0 commit comments

Comments
 (0)