Skip to content

Commit fcdc8dd

Browse files
committed
Update README for improved clarity and add getting started section
1 parent 9c07d67 commit fcdc8dd

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# functorcoder
2-
**functorcoder** is an open source AI coding assistant utilizing LLM (Large Language Model) with algebraic and modular design in Scala.js. It's aimed at providing a clean and extensible architecture for AI coding assistants, which is helpful for understanding basic mechanics if you want to build your own AI coding assistant.
2+
**functorcoder** is an open source AI coding assistant utilizing LLM (Large Language Model) with algebraic and modular design in Scala.js. It aims at providing a clean and extensible architecture for AI coding assistants, which is helpful for understanding basic mechanics if you want to build your own AI coding assistant.
33

44
features aiming to implement:
55
- code generation: completion, documentation
@@ -10,6 +10,9 @@ current features implemented:
1010
- auto completion as you type
1111
- add documentation quick fix action
1212

13+
## Getting Started
14+
Visit [vscode-scalajs-hello](https://github.com/doofin/vscode-scalajs-hello) to understand how to play with scala.js for VSCode extension development. Basically, sbt is used to build the project and run the extension.
15+
1316
## Project Structure
1417
The project is divided into two main parts: the core module and the VSCode extension module under /src/main/scala/functorcoder and /src/main/scala/vscextension respectively.
1518

@@ -59,6 +62,7 @@ The project file structure for the VSCode extension module:
5962
...
6063
```
6164

65+
6266
## design principles
6367
I am to design the system with mathematics, algebra and functional programming principles in mind. The system is designed to be modular and extensible, allowing for easy addition of new features and components.
6468

0 commit comments

Comments
 (0)