Skip to content

Commit

Permalink
fix: modify readme org
Browse files Browse the repository at this point in the history
  • Loading branch information
SergioRibera committed Sep 23, 2024
1 parent fa161b1 commit a1456fb
Showing 1 changed file with 26 additions and 24 deletions.
50 changes: 26 additions & 24 deletions Readme.org
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
# Zed Editor Plugin Template
Certainly! Here's the Emacs Org format version of the markdown in English:

This is a template for creating plugins for the Zed editor using `cargo-generate`. It supports generating three types of plugins:
#+TITLE: Zed Editor Plugin Template

This is a template for creating plugins for the Zed editor using ~cargo-generate~. It supports generating three types of plugins:

1. Language Server plugins
2. Theme plugins
3. Slash Command plugins

## Prerequisites
* Prerequisites

Before you begin, ensure you have the following installed:

- [Rust](https://www.rust-lang.org/tools/install)
- [cargo-generate](https://github.com/cargo-generate/cargo-generate)
- [[https://www.rust-lang.org/tools/install][Rust]]
- [[https://github.com/cargo-generate/cargo-generate][cargo-generate]]

You can install `cargo-generate` with:
You can install ~cargo-generate~ with:

```sh
#+BEGIN_SRC sh
cargo install cargo-generate
```
#+END_SRC

## Usage
* Usage

To use this template and create a new Zed plugin project, run the following command:

```sh
#+BEGIN_SRC sh
cargo generate --git https://github.com/yourusername/zed-plugin-template.git
```
#+END_SRC

Follow the prompts to configure your plugin. The generator will ask you questions about:

Expand All @@ -36,26 +38,26 @@ Follow the prompts to configure your plugin. The generator will ask you question

Based on your answers, it will generate the appropriate files for your plugin type.

## Template Structure
* Template Structure

The template includes the following key files:

- `Cargo.toml.liquid`: The Rust project configuration file
- `extension.toml.liquid`: The Zed extension configuration file
- `README.md.liquid`: A template for the plugin's README
- `src/{{lsp_name}}.rs.liquid`: Template for Language Server plugins
- `themes/{{plugin_id}}.json.liquid`: Template for Theme plugins
- `src/{{slash_command_name}}.rs.liquid`: Template for Slash Command plugins
- ~Cargo.toml.liquid~: The Rust project configuration file
- ~extension.toml.liquid~: The Zed extension configuration file
- ~README.md.liquid~: A template for the plugin's README
- ~src/{{lsp_name}}.rs.liquid~: Template for Language Server plugins
- ~themes/{{plugin_id}}.json.liquid~: Template for Theme plugins
- ~src/{{slash_command_name}}.rs.liquid~: Template for Slash Command plugins

## Customization
* Customization

After generating your project, you can further customize it by:

1. Editing the generated files to add your specific plugin logic
2. Updating the README with more detailed information about your plugin
3. Adding additional dependencies to `Cargo.toml` if needed
3. Adding additional dependencies to ~Cargo.toml~ if needed

## Contributing to the Template
* Contributing to the Template

If you'd like to contribute to this template:

Expand All @@ -64,11 +66,11 @@ If you'd like to contribute to this template:
3. Make your changes
4. Submit a pull request with a clear description of your improvements

## License
* License

This template is licensed under the MIT OR Apache-2.0 license. See the `LICENSE-MIT` and `LICENSE-APACHE` files for details.
This template is licensed under the MIT OR Apache-2.0 license. See the ~LICENSE-MIT~ and ~LICENSE-APACHE~ files for details.

## Support
* Support

If you encounter any issues or have questions about using this template, please open an issue in the GitHub repository.

Expand Down

0 comments on commit a1456fb

Please sign in to comment.