Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardoduplos committed Jan 9, 2025
1 parent 36e8948 commit 541a728
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
13 changes: 9 additions & 4 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ If you use [`nvm`](https://github.com/creationix/nvm), activate the desired Node
nvm install
```

You'll also need to use the correct `yarn` version. Enable with
```
corepack enable
```

Install Node modules:

```
Expand All @@ -27,9 +32,9 @@ yarn install

The project uses `yarn workspaces` and `lerna` to manage the monorepo structure.
There are three main packages in this project:
- `@deveed-ui/collecticons-react` - The Collecticons library for React
- `@deveed-ui/collecticons-chakra` - The Collecticons library specifically for Chakra UI
- `@deveed-ui/collecticons-showcase` - A private package that contains the showcase website for Collecticons
- [`@deveed-ui/collecticons-react](./packages/collecticons-react)` - The Collecticons library for React
- [`@deveed-ui/collecticons-chakra](./packages/collecticons-chakra)` - The Collecticons library specifically for Chakra UI
- [`@deveed-ui/collecticons-showcase](./showcase)` - A private package that contains the showcase website for Collecticons

The first thing to do is generate the JSX icons from the SVG files, both for the React and Chakra UI packages.

Expand All @@ -39,4 +44,4 @@ yarn icons
```
The generated icons will be placed in the `lib/icons` directory of each package. This is gitignored so you don't need to worry about them.

Now you can work on each package individually following the respective instructions.
Now you can work on each package individually following the respective README.md instructions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@
"packages/*",
"showcase"
],
"packageManager": "yarn@4.3.0"
"packageManager": "yarn@4.6.0"
}
2 changes: 1 addition & 1 deletion showcase/src/components/app.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ export function App() {
<Text mb={4}>
If you feel like contributing to this library checkout our{' '}
<TextLink
href='https://github.com/developmentseed/collecticons-lib'
href='https://github.com/developmentseed/collecticons'
title='View collecticons icon library'
>
collecticons library
Expand Down

0 comments on commit 541a728

Please sign in to comment.