Skip to content

Commit d77ad0c

Browse files
authored
Fixed a few nitpicks in README.md (#18)
Changed some text in the README to improve readability or consistency. - [ISS-201021](https://app.devrev.ai/devrev/works/ISS-201021)
1 parent c1d1319 commit d77ad0c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Before you begin, ensure you have the following set up on your local machine.
2121

2222
#### Folder Structure
2323

24-
Your snap-in project directory must be a sibling to a clone of this `airdrop-shared` repository.
24+
Your snap-in project directory must be in the same root directory as `airdrop-shared` repository.
2525

2626
```sh
2727
# Your project layout should look like this
@@ -48,11 +48,11 @@ Clone the Codeplain client repository, which contains the code generation script
4848

4949
In the root of your new snap-in project directory, create and configure the following files.
5050

51-
- **`manifest.yaml`**
51+
- **`manifest.yaml`**:
5252
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).
5353

54-
- **`config.yaml`**
55-
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.
54+
- **`config.yaml`**:
55+
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).
5656

5757
*Example `config.yaml`:*
5858

@@ -68,7 +68,7 @@ In the root of your new snap-in project directory, create and configure the foll
6868
# render-range: 2.3.1,2.3.2
6969
```
7070

71-
- **`.env`**
71+
- **`.env`**:
7272
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.
7373

7474
*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
8181
CHEF_CLI_PATH=/Users/yourname/path/to/chef-cli
8282
```
8383

84-
- **`devrev-<external-system>-snapin.plain`**
85-
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.
84+
- **`devrev-<external-system>-snapin.plain`**:
85+
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.
8686

8787
- Learn more about the specification language: [Plain Language Specification Guide](https://github.com/Codeplain-ai/plain2code_client/blob/main/Plain-language-specification.md)
8888

89-
- **`test_data/`** (Folder)
89+
- **`test_data/`**:
9090
Create this folder to store JSON data files that your Acceptance tests will use.
9191

9292
### 3\. Running Code Generation
@@ -191,4 +191,4 @@ Your local snap-in repository can override any file from this shared repository.
191191

192192
- *Example*: To override `airdrop-shared/test_data/data_extraction_check.json`, create the file `your-new-snap-in/test_data/data_extraction_check.json`.
193193

194-
- **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`.
194+
- **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`.

0 commit comments

Comments
 (0)