From 763648ec3e0a823b348baa4c90880a6979c4c0f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C5=A1per=20Zgonec?= Date: Wed, 13 Aug 2025 14:41:19 +0200 Subject: [PATCH] Changed few README nitpicks. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 09fe260..de7bc58 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Before you begin, ensure you have the following set up on your local machine. #### Folder Structure -Your snap-in project directory must be a sibling to a clone of this `airdrop-shared` repository. +Your snap-in project directory must be in the same root directory as `airdrop-shared` repository. ```sh # Your project layout should look like this @@ -48,11 +48,11 @@ Clone the Codeplain client repository, which contains the code generation script In the root of your new snap-in project directory, create and configure the following files. - - **`manifest.yaml`** + - **`manifest.yaml`**: This file defines your snap-in's metadata. It is **not** generated automatically. You must create one tailored to your snap-in's needs. For guidance, refer to the [DevRev manifest documentation](https://developer.devrev.ai/public/airdrop/manifest). - - **`config.yaml`** - This file configures the code generation process. You must include paths pointing to the cloned `airdrop-shared` repository. Other fields can be adjusted to assist with rendering. + - **`config.yaml`**: + This file configures the code generation process. You must include paths pointing to the cloned `airdrop-shared` repository. Other fields can be adjusted to assist with code generation (rendering). *Example `config.yaml`:* @@ -68,7 +68,7 @@ In the root of your new snap-in project directory, create and configure the foll # render-range: 2.3.1,2.3.2 ``` - - **`.env`** + - **`.env`**: Create a `.env` file to store sensitive information and local paths. At a minimum, it must contain the absolute path to the `chef-cli` binary. Add any other variables, such as API credentials, that your project requires. *Example `.env` for a Wrike snap-in:* @@ -81,12 +81,12 @@ In the root of your new snap-in project directory, create and configure the foll CHEF_CLI_PATH=/Users/yourname/path/to/chef-cli ``` - - **`devrev--snapin.plain`** - This is the core specification file for your snap-in. It is highly recommended to copy the `.plain` file from an existing snap-in (like Trello or Wrike) and modify it. Start with a minimal set of functional requirements and expand as you go. + - **`devrev--snapin.plain`**: + This is the core specification file for your snap-in. It is highly recommended to copy the `.plain` file from an existing snap-in (like [Trello](https://github.com/devrev/airdrop-trello-snap-in) or [Wrike](https://github.com/devrev/airdrop-wrike-snap-in)) and modify it. Start with a minimal set of functional requirements and expand as you go. - Learn more about the specification language: [Plain Language Specification Guide](https://github.com/Codeplain-ai/plain2code_client/blob/main/Plain-language-specification.md) - - **`test_data/`** (Folder) + - **`test_data/`**: Create this folder to store JSON data files that your Acceptance tests will use. ### 3\. Running Code Generation @@ -191,4 +191,4 @@ Your local snap-in repository can override any file from this shared repository. - *Example*: To override `airdrop-shared/test_data/data_extraction_check.json`, create the file `your-new-snap-in/test_data/data_extraction_check.json`. - - **Scripts & Auxiliary Files**: To customize a script, copy it from `airdrop-shared/scripts/` into your snap-in's repository and modify it as needed. Remember to update the corresponding path in your `config.yaml`. \ No newline at end of file + - **Scripts & Auxiliary Files**: To customize a script, copy it from `airdrop-shared/scripts/` into your snap-in's repository and modify it as needed. Remember to update the corresponding path in your `config.yaml`.