This repository was archived by the owner on Dec 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Update README.md
Anton Bastin
committed
Mar 19, 2024
1 parent
aa3ebcc
commit 0e04644
Showing
1 changed file
with
45 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,57 @@ | ||
# Website | ||
# Chirp Token Documentation | ||
|
||
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator. | ||
Welcome to the Chirp Token Documentation repository! | ||
|
||
## Local Development | ||
|
||
To set up the development environment and preview the documentation locally, follow these steps: | ||
|
||
### Prerequisites | ||
|
||
- Node.js and npm installed on your system. You can download and install them from [here](https://nodejs.org/). | ||
- Yarn package manager. Install it globally via npm by running: | ||
```sh | ||
npm install -g yarn | ||
``` | ||
|
||
### Installation | ||
|
||
``` | ||
$ yarn | ||
1. Clone this repository to your local machine: | ||
```sh | ||
git clone git@github.com:chirpwireless/docs.chirptoken.io.git | ||
``` | ||
2. Navigate to the project directory: | ||
```sh | ||
cd docs.chirptoken.io | ||
``` | ||
3. Install the dependencies using Yarn: | ||
```sh | ||
yarn install | ||
``` | ||
|
||
### Local Development Server | ||
|
||
Once the installation is complete, you can start the local development server to preview the documentation: | ||
|
||
```sh | ||
yarn start | ||
``` | ||
|
||
### Local Development | ||
This command starts a development server and opens the documentation site in your default web browser. Any changes you make to the documentation files will be automatically reflected in the browser. | ||
|
||
``` | ||
$ yarn start | ||
``` | ||
## Contributing | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
We welcome contributions from the community to improve and expand our documentation. If you find any issues, errors, or have suggestions for improvement, please don't hesitate to open an issue or pull request in this repository. | ||
|
||
### Build | ||
### How to Contribute | ||
|
||
``` | ||
$ yarn build | ||
``` | ||
1. Fork the repository. | ||
2. Make your changes in a new branch. | ||
3. Submit a pull request with a clear description of your changes. | ||
4. Your pull request will be reviewed by our team, and we'll work with you to get it merged. | ||
|
||
## Contact Us | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
If you have any questions, feedback, or need support, feel free to contact us or open an issue in this repository. We're here to help! | ||
|
||
Thank you for choosing Chirp Token! |