From caa2f007368919888add34c3c10cfdd14490b282 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sun, 2 Nov 2025 23:32:36 +0000 Subject: [PATCH 1/2] feat: Add README.md Adds a comprehensive README.md file to the project, including a project description, instructions on how to run the project locally, and guidelines for contributing. --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..052a61cd --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# Pinguino.cc Website + +This is the source code for the official Pinguino Project website, available at [pinguino.cc](https://pinguino.cc). + +## About the Project + +The Pinguino Project is an open-source electronics prototyping platform. It consists of an Integrated Development Environment (IDE) and hardware boards. This website serves as the main resource for documentation, news, and community interaction. + +The website is built using [VitePress](https://vitepress.dev/), a static site generator that is fast, easy to use, and highly customizable. + +## Getting Started + +To run the website locally, you will need to have [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) installed. + +1. **Clone the repository:** + + ```bash + git clone https://github.com/Pinguino-cc/pinguino-cc.git + ``` + +2. **Run the development server:** + + ```bash + docker-compose up + ``` + +The website will be available at `http://localhost:5173`. + +## Contributing + +We welcome contributions to the Pinguino.cc website. If you would like to contribute, please follow these steps: + +1. **Fork the repository.** +2. **Create a new branch for your changes.** +3. **Make your changes.** +4. **Submit a pull request.** + +We ask that all contributors adhere to our [Code of Conduct](https://github.com/Pinguino-cc/pinguino-cc/blob/main/CODE_OF_CONDUCT.md). + +## License + +This project is licensed under the MIT License. See the [LICENSE](https://github.com/Pinguino-cc/pinguino-cc/blob/main/LICENSE) file for more information. From 78d1ffabf96d12b5fe43e5cf2a02fc9d38968d6a Mon Sep 17 00:00:00 2001 From: Victor Villarreal Date: Sun, 2 Nov 2025 20:41:25 -0300 Subject: [PATCH 2/2] fix(doc): Update REAME.md --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 052a61cd..3ddd2861 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Pinguino.cc Website -This is the source code for the official Pinguino Project website, available at [pinguino.cc](https://pinguino.cc). +This is the source code for the official Pinguino Project website, available at [pinguinoide.github.io](https://pinguinoide.github.io). ## About the Project @@ -21,7 +21,23 @@ To run the website locally, you will need to have [Docker](https://www.docker.co 2. **Run the development server:** ```bash + # Create de container service (for first time) + docker compose up --no-start + + # Install dependencies + docker compose run pinuino-cc npm install + + # Excecute de dev environment docker-compose up + + # Verify the status + docker compose ps + + # Stop the service + docker compose stop + + # Delete the service + docker compose down ``` The website will be available at `http://localhost:5173`. @@ -35,7 +51,6 @@ We welcome contributions to the Pinguino.cc website. If you would like to contri 3. **Make your changes.** 4. **Submit a pull request.** -We ask that all contributors adhere to our [Code of Conduct](https://github.com/Pinguino-cc/pinguino-cc/blob/main/CODE_OF_CONDUCT.md). ## License