Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix code mistake in Markdown #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix code mistake in Markdown #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# refact-sublime
Refact for Sublime is a free, open-source AI code assistant

#Installation Instructions
# Installation Instructions
1. Download the repository.
2. Download the refact-lsp server executable from https://github.com/smallcloudai/refact-lsp
3. Move the server executable to the Server folder and rename the executable "refact-lsp"
4. Move the folder repsository to sublime's "Packages" folder (you can find this by opening the command prompt in sublime and typing "browse packages")
5. rename the folder to "refact"
5. Rename the folder to "refact"
6. Open refact.sublime-settings and add the API key

#Pause
# Pause
You can pause and unpause refact suggestions by pressing ctrl + alt + p

#File Documentation#
# File Documentation

#__init__.py
## \_\_init\_\_.py

Entry point receives key events and update events. It calls refact_sessions methods depending on the event fired.

#refact_sessions.py
## refact_sessions.py

On initialization starts the Refact process and gets the connection to the server for LSP calls.

Expand All @@ -28,35 +28,35 @@ Holds the session state for each open file. Whenever a new session is created th

Calls PhantomState which handles displaying the grey text suggestions.

#refact_process.py
## refact_process.py

Starts the server process and resets the server if it dies. Logs messages from the server and informs the statusbar about server errors.

#refact_lsp.py
## refact_lsp.py

Used to communicate directly with the lsp server.

#phantom_state.py
## phantom_state.py

Responsible for displaying the grey text suggestions.

#completion_text.py
## completion_text.py

Helper functions used by PhantomState to determine the exact text that needs to be displayed.

#utils.py
## utils.py

Helper functions for interacting with the sublime api


#Default.sublime-keymap
## Default.sublime-keymap

Used to setup key mappings for suggestion completions.

#Main.sublime-menu
## Main.sublime-menu

Adds a “pause refact” button to the tools button in the headings.

#refact.sublime-settings
## refact.sublime-settings

Holds the settings for the Refact plugin.