Skip to content

Commit 8aee865

Browse files
committed
Update README for Freebies and Auto-Coder
1 parent 10e5684 commit 8aee865

File tree

2 files changed

+74
-3
lines changed

2 files changed

+74
-3
lines changed

freebies/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
1-
inside a new folder, run `npm install @langchain/community`
1+
# Freebies
22

3-
drop `setup.js` into the folder
3+
Welcome to the "Freebies" directory! This is a collection of free tools and scripts that I've been developing for myself, which I believe could be useful to the open source community. Feel free to explore, use, and contribute to these tools.
44

5-
run `node setup.js`
5+
## Tools in This Directory
6+
7+
- [auto-coder](https://github.com/ctavolazzi/NovaSystem/tree/main/freebies/auto-coder)
8+
9+
## License
10+
11+
This project is licensed under the GPL-3.0 License.
12+
13+
The entire NovaSystem repository, including this "freebies" directory, is licensed under GPL-3.0. This means you are free to use, modify, and distribute this code, provided you adhere to the terms of the GPL-3.0 license.
14+
15+
## Contributing
16+
17+
If you have any suggestions, bug reports, or contributions, feel free to open an issue or submit a pull request. Your feedback and contributions are greatly appreciated!

freebies/auto-coder/README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Auto Coder
2+
3+
The `auto-coder` tool is designed to automate code generation and improvement processes using the `Ollama` model from the `@langchain/community` package. This tool can help streamline your coding tasks by generating and refining code based on specified parameters.
4+
5+
## Setup Instructions
6+
7+
Follow these steps to set up the `auto-coder` tool:
8+
9+
1. **Create a New Directory**
10+
11+
Create a new directory where you want to set up the `auto-coder` tool.
12+
13+
```bash
14+
mkdir auto-coder-setup
15+
cd auto-coder-setup
16+
```
17+
18+
2. **Install the Required Package**
19+
20+
Install the `@langchain/community` package by running the following command:
21+
22+
```bash
23+
npm install @langchain/community
24+
```
25+
26+
3. **Add the `setup.js` Script**
27+
28+
Download or copy the `setup.js` script into the directory. The `setup.js` script will handle the initial setup process, including creating necessary files and downloading the main `auto-coder.js` script.
29+
30+
4. **Run the Setup Script**
31+
32+
Execute the `setup.js` script to complete the setup process:
33+
34+
```bash
35+
node setup.js
36+
```
37+
38+
The `setup.js` script will perform the following actions:
39+
- Create or update the `package.json` file to include the necessary dependencies and set the type to "module".
40+
- Install the required packages.
41+
- Create an `example_code.txt` file with default content if it doesn't exist.
42+
- Create a `config.json` file with default configuration values if it doesn't exist.
43+
- Download the main `auto-coder.js` script from the GitHub repository.
44+
45+
5. **Run the `auto-coder.js` Script**
46+
47+
After the setup is complete, you can run the `auto-coder.js` script to start using the tool:
48+
49+
```bash
50+
node auto-coder.js
51+
```
52+
53+
## License
54+
55+
This project is licensed under the GPL-3.0 License.
56+
57+
## Contributing
58+
59+
If you have any suggestions, bug reports, or contributions, feel free to open an issue or submit a pull request. Your feedback and contributions are greatly appreciated!

0 commit comments

Comments
 (0)